From 15f351b2a808db5bed706f23223d765be75850a3 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Tue, 23 Jun 2020 09:29:06 +0000 Subject: [PATCH] commit 0d06fcac9760b564da9939eec61ae46daf5d309e Author: Robert Kaussow Date: Tue Jun 23 11:24:44 2020 +0200 switch back to master branch for docker_engine role --- index.md | 116 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 84 insertions(+), 32 deletions(-) diff --git a/index.md b/index.md index 207e2e4..e85b517 100644 --- a/index.md +++ b/index.md @@ -36,9 +36,7 @@ Setup [FreshRSS](https://freshrss.org/) server. FreshRSS is a self-hosted RSS fe * [freshrss_db_user](#freshrss_db_user) * [freshrss_default_password](#freshrss_default_password) * [freshrss_default_user](#freshrss_default_user) - * [freshrss_docker_compose_bin](#freshrss_docker_compose_bin) - * [freshrss_exposed_ip](#freshrss_exposed_ip) - * [freshrss_exposed_port](#freshrss_exposed_port) + * [freshrss_exposed_ports](#freshrss_exposed_ports) * [freshrss_extensions_enabled](#freshrss_extensions_enabled) * [freshrss_extra_hosts](#freshrss_extra_hosts) * [freshrss_healthcheck](#freshrss_healthcheck) @@ -54,16 +52,20 @@ Setup [FreshRSS](https://freshrss.org/) server. FreshRSS is a self-hosted RSS fe * [freshrss_memory_limit](#freshrss_memory_limit) * [freshrss_memory_reservation](#freshrss_memory_reservation) * [freshrss_meta_description](#freshrss_meta_description) + * [freshrss_networks](#freshrss_networks) + * [freshrss_networks_applied](#freshrss_networks_applied) * [freshrss_pids_limit](#freshrss_pids_limit) * [freshrss_pubsubhubbub_enabled](#freshrss_pubsubhubbub_enabled) * [freshrss_restart_policy](#freshrss_restart_policy) * [freshrss_salt](#freshrss_salt) * [freshrss_security_opt](#freshrss_security_opt) * [freshrss_service_directory](#freshrss_service_directory) + * [freshrss_service_stopped](#freshrss_service_stopped) * [freshrss_simplepie_syslog_enabled](#freshrss_simplepie_syslog_enabled) * [freshrss_title](#freshrss_title) * [freshrss_unsafe_autologin_enabled](#freshrss_unsafe_autologin_enabled) * [freshrss_version](#freshrss_version) + * [freshrss_volumes](#freshrss_volumes) * [Dependencies](#dependencies) --- @@ -75,7 +77,7 @@ Setup [FreshRSS](https://freshrss.org/) server. FreshRSS is a self-hosted RSS fe #### Default value ```YAML -freshrss_allow_anonymous: 'false' +freshrss_allow_anonymous: false ``` ### freshrss_allow_anonymous_refresh @@ -83,7 +85,7 @@ freshrss_allow_anonymous: 'false' #### Default value ```YAML -freshrss_allow_anonymous_refresh: 'false' +freshrss_allow_anonymous_refresh: false ``` ### freshrss_allow_referrer @@ -91,7 +93,7 @@ freshrss_allow_anonymous_refresh: 'false' #### Default value ```YAML -freshrss_allow_referrer: 'false' +freshrss_allow_referrer: false ``` ### freshrss_allow_robots @@ -99,7 +101,7 @@ freshrss_allow_referrer: 'false' #### Default value ```YAML -freshrss_allow_robots: 'false' +freshrss_allow_robots: false ``` ### freshrss_api_enabled @@ -107,7 +109,7 @@ freshrss_allow_robots: 'false' #### Default value ```YAML -freshrss_api_enabled: 'false' +freshrss_api_enabled: false ``` ### freshrss_auth_type @@ -277,7 +279,7 @@ freshrss_db_ssl_rootcert: /etc/ssl/certs/ca-certificates.crt #### Default value ```YAML -freshrss_db_type: pgsql +freshrss_db_type: sqlite ``` ### freshrss_db_user @@ -285,7 +287,7 @@ freshrss_db_type: pgsql #### Default value ```YAML -freshrss_db_user: pgfreshrss +freshrss_db_user: freshrss ``` ### freshrss_default_password @@ -304,28 +306,13 @@ freshrss_default_password: freshrss freshrss_default_user: admin ``` -### freshrss_docker_compose_bin +### freshrss_exposed_ports #### Default value ```YAML -freshrss_docker_compose_bin: /usr/local/bin/docker-compose -``` - -### freshrss_exposed_ip - -#### Default value - -```YAML -freshrss_exposed_ip: 127.0.0.1 -``` - -### freshrss_exposed_port - -#### Default value - -```YAML -freshrss_exposed_port: 80 +freshrss_exposed_ports: + - 127.0.0.1:8080:8080 ``` ### freshrss_extensions_enabled @@ -467,6 +454,33 @@ freshrss_memory_reservation: 256m freshrss_meta_description: _unset_ ``` +### freshrss_networks + +#### Default value + +```YAML +freshrss_networks: + - name: default +``` + +#### Example usage + +```YAML +freshrss_networks: + - name: default + # optional network driver, defaults to 'bride' + driver: host +``` + +### freshrss_networks_applied + +#### Default value + +```YAML +freshrss_networks_applied: + - default +``` + ### freshrss_pids_limit #### Default value @@ -480,7 +494,7 @@ freshrss_pids_limit: _unset_ #### Default value ```YAML -freshrss_pubsubhubbub_enabled: 'false' +freshrss_pubsubhubbub_enabled: false ``` ### freshrss_restart_policy @@ -488,7 +502,7 @@ freshrss_pubsubhubbub_enabled: 'false' #### Default value ```YAML -freshrss_restart_policy: on-failure +freshrss_restart_policy: always ``` ### freshrss_salt @@ -517,12 +531,20 @@ freshrss_security_opt: [] freshrss_service_directory: /var/lib/docker/services/freshrss ``` +### freshrss_service_stopped + +#### Default value + +```YAML +freshrss_service_stopped: false +``` + ### freshrss_simplepie_syslog_enabled #### Default value ```YAML -freshrss_simplepie_syslog_enabled: 'true' +freshrss_simplepie_syslog_enabled: true ``` ### freshrss_title @@ -538,7 +560,7 @@ freshrss_title: FreshRSS #### Default value ```YAML -freshrss_unsafe_autologin_enabled: 'false' +freshrss_unsafe_autologin_enabled: false ``` ### freshrss_version @@ -549,6 +571,36 @@ freshrss_unsafe_autologin_enabled: 'false' freshrss_version: latest ``` +### freshrss_volumes + +> Define required docker volumes. + +#### Default value + +```YAML +freshrss_volumes: + - name: data + dest: /var/www/app/data + bind: false + - name: extensions + dest: /var/www/app/extensions + bind: false +``` + +#### Example usage + +```YAML +freshrss_volumes: + # Instead of the name you could specify a path on the container host system, + # but you also have to enable bind mount for this volume + - name: data + # target location inside the container + dest: /var/www/app/data + # enable bind mount, if false volume will be configured as named volume + # keep in mind you MUST set bind in any case + bind: True +``` + ## Dependencies None.