Kharec/ansible-role-freshrss
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Sandro CURY CAZZANIGA
2025-11-16 15:39:11 +01:00
parent 4686d0d5f5
commit 02d3e02919
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -19,14 +19,22 @@ It **does not** deploy php, nor a webserver or a database. However, it does inst
```yaml ```yaml
freshrss_root_dir: "/var/www" freshrss_root_dir: "/var/www"
freshrss_path: "/var/www/rss"
freshrss_version: "1.27.1" freshrss_version: "1.27.1"
freshrss_refresh_interval: 15 # every 15 minutes 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)
## FreshRSS configuration ## FreshRSS configuration
It's done once deployed, navigate to the address you’ve installed your server to complete the installation from the GUI. The configuration is to be done once deployed.
Navigate to the address you’ve installed your server to complete the installation from the GUI.
## License ## License