55 lines
2.4 KiB
Markdown
55 lines
2.4 KiB
Markdown
# ansible-role-freshrss
|
||
|
||
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.
|
||
|
||
## Requirements
|
||
|
||
- Ansible 2.10
|
||
- Deb-based distribution (Debian, Ubuntu, etc.)
|
||
|
||
## Dependencies
|
||
|
||
This role doesn't have any dependencies to other roles.
|
||
|
||
## Playbook example
|
||
|
||
```yaml
|
||
---
|
||
- name: Deploy FreshRSS
|
||
hosts: freshrss_servers
|
||
become: true
|
||
vars:
|
||
freshrss_root_dir: "/var/www"
|
||
freshrss_version: "1.27.1"
|
||
freshrss_checksum: "99fd1d0e6f506832e6600c98e4c9369edad6bfec715df9b1b7c8c3eb6a455c22"
|
||
freshrss_refresh_interval: 10
|
||
roles:
|
||
- ansible-role-freshrss
|
||
```
|
||
|
||
## Variables
|
||
|
||
| Variable | Required | Default | Description |
|
||
| --------------------------- | -------- | ---------------------------------- | ---------------------------------------------------------------- |
|
||
| `freshrss_checksum` | No | `""` | SHA256 checksum to verify the archive if user sets it |
|
||
| `freshrss_group` | No | `www-data` | Group that will own FreshRSS files |
|
||
| `freshrss_path` | No | `{{ freshrss_root_dir }}/freshrss` | Web-accessible path where FreshRSS will be symlinked |
|
||
| `freshrss_refresh_interval` | No | `15` | Feed refresh interval in minutes (every X minutes) |
|
||
| `freshrss_root_dir` | **Yes** | - | Directory where FreshRSS archive is downloaded and extracted |
|
||
| `freshrss_user` | No | `www-data` | User that will own FreshRSS files and run the cron job |
|
||
| `freshrss_version` | **Yes** | - | FreshRSS version to deploy (e.g., `"1.27.1"`) |
|
||
|
||
## Additional information
|
||
|
||
FreshRSS configuration is to be done once deployed.
|
||
|
||
Navigate to the address you’ve installed your server to complete the installation from the GUI.
|
||
|
||
## License
|
||
|
||
This project is licensed under the GNU General Public License v3.0 or later (GPLv3+). See the [LICENSE](LICENSE) file for details.
|