diff --git a/README.md b/README.md index abd0f56..b0c249a 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,33 @@ This role deploys [FreshRSS](https://www.freshrss.org/) to your server(s). -It **does not** deploy php, nor a webserver or a database. However, it does install the PHP dependencies for FreshRSS, including php-sqlite3 in case you want to use a simple SQLite database. +It **does not** deploy php, nor a webserver or a database. -## Example playbook +However, it does install the PHP dependencies for FreshRSS, including php-sqlite3 in case you want to use a simple SQLite database. + +## Playbook example ```yaml +--- - name: Deploy FreshRSS - hosts: freshrss + hosts: freshrss_servers become: true - + vars: + freshrss_root_dir: "/var/www" + freshrss_version: "1.27.1" + freshrss_refresh_interval: 15 roles: - freshrss ``` -## Example var file +## Variables: -```yaml -freshrss_root_dir: "/var/www" -freshrss_version: "1.27.1" -freshrss_refresh_interval: 15 -``` - -Variables: - -- `freshrss_root_dir`: Directory where FreshRSS archive is downloaded and extracted (required) -- `freshrss_path`: Web-accessible path where FreshRSS will be symlinked (defaults to `{{ freshrss_root_dir }}/freshrss`) -- `freshrss_version`: FreshRSS version to deploy (e.g., "1.27.1") -- `freshrss_refresh_interval`: Feed refresh interval in minutes (e.g., 15 = every 15 minutes) +| Variable | Default | Required | Description | +| --------------------------- | ---------------------------------- | -------- | ---------------------------------------------------------------- | +| `freshrss_root_dir` | - | **Yes** | Directory where FreshRSS archive is downloaded and extracted | +| `freshrss_path` | `{{ freshrss_root_dir }}/freshrss` | No | Web-accessible path where FreshRSS will be symlinked | +| `freshrss_version` | - | **Yes** | FreshRSS version to deploy (e.g., `"1.27.1"`) | +| `freshrss_refresh_interval` | - | **Yes** | Feed refresh interval in minutes (e.g., `15` = every 15 minutes) | ## FreshRSS configuration