diff options
Diffstat (limited to 'roles/ttrss')
| -rw-r--r-- | roles/ttrss/README.md | 75 | ||||
| -rw-r--r-- | roles/ttrss/defaults/main.yml | 1 | ||||
| -rw-r--r-- | roles/ttrss/templates/var/www/ttrss/config.php.j2 | 2 | ||||
| -rw-r--r-- | roles/ttrss/vars/main.yml | 1 |
4 files changed, 77 insertions, 2 deletions
diff --git a/roles/ttrss/README.md b/roles/ttrss/README.md new file mode 100644 index 0000000..7e6c9da --- /dev/null +++ b/roles/ttrss/README.md @@ -0,0 +1,75 @@ +Tiny Tiny RSS +============= + +Description +----------- + +The `ttrss` role installs and configures the [Tiny Tiny RSS](https://tt-rss.org/) +feed aggregator. + +The [ttrss-auth-ldap](https://github.com/sacredheartsc/ttrss-freeipa) is used to +authenticate users against the local FreeIPA domain. + +This role configures the PHP application only; it does not configure the webserver. + + +Variables +--------- + +This role **accepts** the following variables: + +Variable | Default | Description +-------------------------------|------------------------------------|------------ +`ttrss_version` | `HEAD` | Git version of TT-RSS to install +`ttrss_freeipa_plugin_version` | `HEAD` | Git version of FreeIPA plugin to install +`ttrss_update_on_calendar` | `weekly` | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for updating TT-RSS +`ttrss_server_name` | `{{ ansible_fqdn }}` | Canonical HTTP hostname +`ttrss_db_host` | `{{ postgresql_host }}` | PostgreSQL host +`ttrss_user` | `s-ttrss` | PostgreSQL user (will be created) +`ttrss_db_name` | `ttrss` | PostgreSQL database (will be created) +`ttrss_session_lifetime_sec` | 604800 | Login session lifetime (seconds) +`ttrss_email_from_name` | `Tiny Tiny RSS` | Email `From:` name +`ttrss_email_from_address` | `ttrss-noreply@{{ email_domain }}` | Email `From:` address +`ttrss_access_group` | `role-ttrss-access` | FreeIPA group for TT-RSS users (will be created) +`ttrss_admin_group` | `role-ttrss-admin` | FreeIPA group for TT-RSS administrators (will be created) + + +### Exports + +This role **exports** the following variables: + +Variable | Description +------------------------|------------ +`ttrss_php_environment` | Dictionary of required environment variables for PHP +`ttrss_apache_config` | Apache config block for TT-RSS +`ttrss_home` | TT-RSS webroot + + +Usage +----- + +Example playbook: + +````yaml +- name: configure tinytinyrss + hosts: ttrss_servers + roles: + - role: ttrss + vars: + ttrss_server_name: ttrss.ipa.example.com + ttrss_db_host: postgres.ipa.example.com + ttrss_access_group: ttrss-users + ttrss_admin_group: ttrss-admins + + + - role: php + vars: + php_fpm_environment: '{{ ttrss_php_environment }}' + + - role: apache_vhost + vars: + apache_default_vhost: yes + apache_canonical_hostname: '{{ ttrss_server_name }}' + apache_document_root: '{{ ttrss_home }}' + apache_config: '{{ ttrss_apache_config }}' +```` diff --git a/roles/ttrss/defaults/main.yml b/roles/ttrss/defaults/main.yml index 02c9b2e..b926623 100644 --- a/roles/ttrss/defaults/main.yml +++ b/roles/ttrss/defaults/main.yml @@ -1,3 +1,4 @@ +ttrss_version: HEAD ttrss_freeipa_plugin_version: HEAD ttrss_update_on_calendar: weekly diff --git a/roles/ttrss/templates/var/www/ttrss/config.php.j2 b/roles/ttrss/templates/var/www/ttrss/config.php.j2 index 9b5e108..3d22694 100644 --- a/roles/ttrss/templates/var/www/ttrss/config.php.j2 +++ b/roles/ttrss/templates/var/www/ttrss/config.php.j2 @@ -1,5 +1,5 @@ <?php -putenv('TTRSS_SELF_URL_PATH={{ ttrss_url }}'); +putenv('TTRSS_SELF_URL_PATH=https://{{ ttrss_server_name }}'); putenv('TTRSS_DB_TYPE=pgsql'); putenv('TTRSS_DB_HOST={{ ttrss_db_host }}'); diff --git a/roles/ttrss/vars/main.yml b/roles/ttrss/vars/main.yml index 15145d4..96bdca4 100644 --- a/roles/ttrss/vars/main.yml +++ b/roles/ttrss/vars/main.yml @@ -17,7 +17,6 @@ ttrss_home: /var/www/ttrss ttrss_keytab: /var/lib/gssproxy/clients/{{ ttrss_user }}.keytab ttrss_git_repo: https://git.tt-rss.org/fox/tt-rss -ttrss_version: HEAD ttrss_freeipa_plugin_url: https://raw.githubusercontent.com/sacredheartsc/ttrss-freeipa/master/auth_freeipa/init.php |