--- title: freshrss_docker type: docs --- Setup FreshRSS server * [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_docker_compose_bin](#freshrss-docker-compose-bin) * [freshrss_exposed_ip](#freshrss-exposed-ip) * [freshrss_exposed_port](#freshrss-exposed-port) * [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_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_simplepie_syslog_enabled](#freshrss-simplepie-syslog-enabled) * [freshrss_title](#freshrss-title) * [freshrss_unsafe_autologin_enabled](#freshrss-unsafe-autologin-enabled) * [freshrss_version](#freshrss-version) * [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: pgsql ``` ### freshrss_db_user #### Default value ```YAML freshrss_db_user: pgfreshrss ``` ### freshrss_default_password #### Default value ```YAML freshrss_default_password: freshrss ``` ### freshrss_default_user #### Default value ```YAML freshrss_default_user: admin ``` ### freshrss_docker_compose_bin #### 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_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: test: '["CMD", "/usr/local/bin/healthcheck.sh"]' interval: 30s timeout: 5s retries: 5 ``` ### freshrss_image #### Default value ```YAML freshrss_image: xoxys/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_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: on-failure ``` ### 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_simplepie_syslog_enabled #### Default value ```YAML freshrss_simplepie_syslog_enabled: 'true' ``` ### freshrss_title #### Default value ```YAML freshrss_title: FreshRSS ``` ### freshrss_unsafe_autologin_enabled #### Default value ```YAML freshrss_unsafe_autologin_enabled: 'false' ``` ### freshrss_version #### Default value ```YAML freshrss_version: latest ``` ## Dependencies None.