--- title: freshrss_docker type: docs --- [![Source Code](https://img.shields.io/badge/gitea-source%20code-blue?logo=gitea&logoColor=white)](https://gitea.rknet.org/ansible/xoxys.freshrss_docker) [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.freshrss_docker?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.freshrss_docker) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitea.rknet.org/ansible/xoxys.freshrss_docker/src/branch/main/LICENSE) Setup [FreshRSS](https://freshrss.org/) server. FreshRSS is a self-hosted RSS feed aggregator. It is lightweight, easy to work with, powerful, and customizable. - [Default Variables](#default-variables) - [freshrss_allow_anonymous](#freshrss_allow_anonymous) - [freshrss_allow_anonymous_refresh](#freshrss_allow_anonymous_refresh) - [freshrss_allow_referrer](#freshrss_allow_referrer) - [freshrss_allow_robots](#freshrss_allow_robots) - [freshrss_api_enabled](#freshrss_api_enabled) - [freshrss_auth_type](#freshrss_auth_type) - [freshrss_base_url](#freshrss_base_url) - [freshrss_cap_add](#freshrss_cap_add) - [freshrss_cap_drop](#freshrss_cap_drop) - [freshrss_container_name](#freshrss_container_name) - [freshrss_cpu_shares](#freshrss_cpu_shares) - [freshrss_curlopt_proxy](#freshrss_curlopt_proxy) - [freshrss_curlopt_proxyauth](#freshrss_curlopt_proxyauth) - [freshrss_curlopt_proxyport](#freshrss_curlopt_proxyport) - [freshrss_curlopt_proxytype](#freshrss_curlopt_proxytype) - [freshrss_curlopt_proxyuserpwd](#freshrss_curlopt_proxyuserpwd) - [freshrss_curlopt_ssl_verifyhost](#freshrss_curlopt_ssl_verifyhost) - [freshrss_curlopt_ssl_verifypeer](#freshrss_curlopt_ssl_verifypeer) - [freshrss_db_name](#freshrss_db_name) - [freshrss_db_password](#freshrss_db_password) - [freshrss_db_port](#freshrss_db_port) - [freshrss_db_server](#freshrss_db_server) - [freshrss_db_ssl_mode](#freshrss_db_ssl_mode) - [freshrss_db_ssl_rootcert](#freshrss_db_ssl_rootcert) - [freshrss_db_type](#freshrss_db_type) - [freshrss_db_user](#freshrss_db_user) - [freshrss_default_password](#freshrss_default_password) - [freshrss_default_user](#freshrss_default_user) - [freshrss_exposed_ports](#freshrss_exposed_ports) - [freshrss_extensions_enabled](#freshrss_extensions_enabled) - [freshrss_extra_hosts](#freshrss_extra_hosts) - [freshrss_healthcheck](#freshrss_healthcheck) - [freshrss_image](#freshrss_image) - [freshrss_language](#freshrss_language) - [freshrss_limits_cache_duration](#freshrss_limits_cache_duration) - [freshrss_limits_cookie_duration](#freshrss_limits_cookie_duration) - [freshrss_limits_max_categories](#freshrss_limits_max_categories) - [freshrss_limits_max_feeds](#freshrss_limits_max_feeds) - [freshrss_limits_max_inactivity](#freshrss_limits_max_inactivity) - [freshrss_limits_max_registrations](#freshrss_limits_max_registrations) - [freshrss_limits_timeout](#freshrss_limits_timeout) - [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_trusted_sources](#freshrss_trusted_sources) - [freshrss_unsafe_autologin_enabled](#freshrss_unsafe_autologin_enabled) - [freshrss_version](#freshrss_version) - [freshrss_volumes](#freshrss_volumes) - [Dependencies](#dependencies) --- ## Default Variables ### freshrss_allow_anonymous #### Default value ```YAML freshrss_allow_anonymous: false ``` ### freshrss_allow_anonymous_refresh #### Default value ```YAML freshrss_allow_anonymous_refresh: false ``` ### freshrss_allow_referrer #### Default value ```YAML freshrss_allow_referrer: false ``` ### freshrss_allow_robots #### Default value ```YAML freshrss_allow_robots: false ``` ### freshrss_api_enabled #### Default value ```YAML freshrss_api_enabled: false ``` ### freshrss_auth_type #### Default value ```YAML freshrss_auth_type: form ``` ### freshrss_base_url Specify address of the freshrss instance, used when building absolute urls, e.g. for websub. #### Default value ```YAML freshrss_base_url: http://localhost/ ``` ### freshrss_cap_add #### Default value ```YAML freshrss_cap_add: [] ``` ### freshrss_cap_drop #### Default value ```YAML freshrss_cap_drop: [] ``` ### freshrss_container_name #### Default value ```YAML freshrss_container_name: freshrss ``` ### freshrss_cpu_shares #### Default value ```YAML freshrss_cpu_shares: _unset_ ``` #### Example usage ```YAML freshrss_cpu_shares: '1024' ``` ### freshrss_curlopt_proxy #### Default value ```YAML freshrss_curlopt_proxy: _unset_ ``` ### freshrss_curlopt_proxyauth #### Default value ```YAML freshrss_curlopt_proxyauth: _unset_ ``` ### freshrss_curlopt_proxyport #### Default value ```YAML freshrss_curlopt_proxyport: _unset_ ``` ### freshrss_curlopt_proxytype #### Default value ```YAML freshrss_curlopt_proxytype: _unset_ ``` ### freshrss_curlopt_proxyuserpwd #### Default value ```YAML freshrss_curlopt_proxyuserpwd: _unset_ ``` ### freshrss_curlopt_ssl_verifyhost #### Default value ```YAML freshrss_curlopt_ssl_verifyhost: _unset_ ``` ### freshrss_curlopt_ssl_verifypeer #### Default value ```YAML freshrss_curlopt_ssl_verifypeer: _unset_ ``` ### freshrss_db_name #### Default value ```YAML freshrss_db_name: freshrss ``` ### freshrss_db_password #### Default value ```YAML freshrss_db_password: secure ``` ### freshrss_db_port #### Default value ```YAML freshrss_db_port: 5432 ``` ### freshrss_db_server #### Default value ```YAML freshrss_db_server: localhost ``` ### freshrss_db_ssl_mode This variable is only supported for `pgsql` DB type. #### Default value ```YAML freshrss_db_ssl_mode: disable ``` ### freshrss_db_ssl_rootcert #### Default value ```YAML freshrss_db_ssl_rootcert: /etc/ssl/certs/ca-certificates.crt ``` ### freshrss_db_type #### Default value ```YAML freshrss_db_type: sqlite ``` ### freshrss_db_user #### Default value ```YAML freshrss_db_user: freshrss ``` ### freshrss_default_password #### Default value ```YAML freshrss_default_password: freshrss ``` ### freshrss_default_user #### Default value ```YAML freshrss_default_user: admin ``` ### freshrss_exposed_ports #### Default value ```YAML freshrss_exposed_ports: - 127.0.0.1:8080:8080 ``` ### freshrss_extensions_enabled List of FreshRSS extensions to enable. Extensions must be already installed! #### Default value ```YAML freshrss_extensions_enabled: - Tumblr-GDPR ``` ### freshrss_extra_hosts #### Default value ```YAML freshrss_extra_hosts: [] ``` ### freshrss_healthcheck #### Default value ```YAML freshrss_healthcheck: _unset_ ``` #### Example usage ```YAML freshrss_healthcheck: test: '["CMD", "/usr/local/bin/healthcheck"]' interval: 30s timeout: 5s retries: 5 ``` ### freshrss_image #### Default value ```YAML freshrss_image: thegeeklab/freshrss:{{ freshrss_version }} ``` ### freshrss_language #### Default value ```YAML freshrss_language: en ``` ### freshrss_limits_cache_duration #### Default value ```YAML freshrss_limits_cache_duration: '800' ``` ### freshrss_limits_cookie_duration #### Default value ```YAML freshrss_limits_cookie_duration: '2592000' ``` ### freshrss_limits_max_categories #### Default value ```YAML freshrss_limits_max_categories: '16384' ``` ### freshrss_limits_max_feeds #### Default value ```YAML freshrss_limits_max_feeds: '16384' ``` ### freshrss_limits_max_inactivity #### Default value ```YAML freshrss_limits_max_inactivity: '10800' ``` ### freshrss_limits_max_registrations #### Default value ```YAML freshrss_limits_max_registrations: '1' ``` ### freshrss_limits_timeout #### Default value ```YAML freshrss_limits_timeout: '15' ``` ### freshrss_memory_limit #### Default value ```YAML freshrss_memory_limit: _unset_ ``` #### Example usage ```YAML freshrss_memory_limit: 512m ``` ### freshrss_memory_reservation #### Default value ```YAML freshrss_memory_reservation: _unset_ ``` #### Example usage ```YAML freshrss_memory_reservation: 256m ``` ### freshrss_meta_description #### Default value ```YAML 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 ```YAML freshrss_pids_limit: _unset_ ``` ### freshrss_pubsubhubbub_enabled #### Default value ```YAML freshrss_pubsubhubbub_enabled: false ``` ### freshrss_restart_policy #### Default value ```YAML freshrss_restart_policy: always ``` ### freshrss_salt Salt is used to make crypto more unique. You can generate your own salt with e.g. `cat /proc/sys/kernel/random/uuid | sha1sum | awk '{print $1}'`. #### Default value ```YAML freshrss_salt: _unset_ ``` ### freshrss_security_opt #### Default value ```YAML freshrss_security_opt: [] ``` ### freshrss_service_directory #### Default value ```YAML 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_title #### Default value ```YAML freshrss_title: FreshRSS ``` ### freshrss_trusted_sources #### Default value ```YAML freshrss_trusted_sources: - 127.0.0.0/8 - ::1/128 ``` ### freshrss_unsafe_autologin_enabled #### Default value ```YAML freshrss_unsafe_autologin_enabled: false ``` ### freshrss_version #### Default value ```YAML 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.