xoxys.freshrss_docker/README.md

xoxys.freshrss_docker

Setup FreshRSS server

Table of content

• Default Variables
  • freshrss_allow_anonymous
  • freshrss_allow_anonymous_refresh
  • freshrss_allow_referrer
  • freshrss_allow_robots
  • freshrss_api_enabled
  • freshrss_auth_type
  • freshrss_base_url
  • freshrss_cap_add
  • freshrss_cap_drop
  • freshrss_container_name
  • freshrss_cpu_shares
  • freshrss_curlopt_proxy
  • freshrss_curlopt_proxyauth
  • freshrss_curlopt_proxyport
  • freshrss_curlopt_proxytype
  • freshrss_curlopt_proxyuserpwd
  • freshrss_curlopt_ssl_verifyhost
  • freshrss_curlopt_ssl_verifypeer
  • freshrss_db_name
  • freshrss_db_password
  • freshrss_db_port
  • freshrss_db_server
  • freshrss_db_ssl_mode
  • freshrss_db_ssl_rootcert
  • freshrss_db_type
  • freshrss_db_user
  • freshrss_default_password
  • freshrss_default_user
  • freshrss_docker_compose_bin
  • freshrss_exposed_ip
  • freshrss_exposed_port
  • freshrss_extensions_enabled
  • freshrss_extra_hosts
  • freshrss_healthcheck
  • freshrss_image
  • freshrss_language
  • freshrss_limits_cache_duration
  • freshrss_limits_cookie_duration
  • freshrss_limits_max_categories
  • freshrss_limits_max_feeds
  • freshrss_limits_max_inactivity
  • freshrss_limits_max_registrations
  • freshrss_limits_timeout
  • freshrss_memory_limit
  • freshrss_memory_reservation
  • freshrss_meta_description
  • freshrss_pids_limit
  • freshrss_pubsubhubbub_enabled
  • freshrss_restart_policy
  • freshrss_salt
  • freshrss_security_opt
  • freshrss_service_directory
  • freshrss_simplepie_syslog_enabled
  • freshrss_title
  • freshrss_unsafe_autologin_enabled
  • freshrss_version
• Dependencies
• License
• Author

---

Default Variables

freshrss_allow_anonymous

Default value

freshrss_allow_anonymous: 'false'

freshrss_allow_anonymous_refresh

Default value

freshrss_allow_anonymous_refresh: 'false'

freshrss_allow_referrer

Default value

freshrss_allow_referrer: 'false'

freshrss_allow_robots

Default value

freshrss_allow_robots: 'false'

freshrss_api_enabled

Default value

freshrss_api_enabled: 'false'

freshrss_auth_type

Default value

freshrss_auth_type: form

freshrss_base_url

Specify address of the freshrss instance, used when building absolute urls, e.g. for websub.

Default value

freshrss_base_url: http://localhost/

freshrss_cap_add

Default value

freshrss_cap_add: []

freshrss_cap_drop

Default value

freshrss_cap_drop: []

freshrss_container_name

Default value

freshrss_container_name: freshrss

freshrss_cpu_shares

Default value

freshrss_cpu_shares: _unset_

Example usage

freshrss_cpu_shares: '1024'

freshrss_curlopt_proxy

Default value

freshrss_curlopt_proxy: _unset_

freshrss_curlopt_proxyauth

Default value

freshrss_curlopt_proxyauth: _unset_

freshrss_curlopt_proxyport

Default value

freshrss_curlopt_proxyport: _unset_

freshrss_curlopt_proxytype

Default value

freshrss_curlopt_proxytype: _unset_

freshrss_curlopt_proxyuserpwd

Default value

freshrss_curlopt_proxyuserpwd: _unset_

freshrss_curlopt_ssl_verifyhost

Default value

freshrss_curlopt_ssl_verifyhost: _unset_

freshrss_curlopt_ssl_verifypeer

Default value

freshrss_curlopt_ssl_verifypeer: _unset_

freshrss_db_name

Default value

freshrss_db_name: freshrss

freshrss_db_password

Default value

freshrss_db_password: secure

freshrss_db_port

Default value

freshrss_db_port: 5432

freshrss_db_server

Default value

freshrss_db_server: localhost

freshrss_db_ssl_mode

This variable is only supported for pgsql DB type.

Default value

freshrss_db_ssl_mode: disable

freshrss_db_ssl_rootcert

Default value

freshrss_db_ssl_rootcert: /etc/ssl/certs/ca-certificates.crt

freshrss_db_type

Default value

freshrss_db_type: pgsql

freshrss_db_user

Default value

freshrss_db_user: pgfreshrss

freshrss_default_password

Default value

freshrss_default_password: freshrss

freshrss_default_user

Default value

freshrss_default_user: admin

freshrss_docker_compose_bin

Default value

freshrss_docker_compose_bin: /usr/local/bin/docker-compose

freshrss_exposed_ip

Default value

freshrss_exposed_ip: 127.0.0.1

freshrss_exposed_port

Default value

freshrss_exposed_port: 80

freshrss_extensions_enabled

List of FreshRSS extensions to enable. Extensions must be already installed!

Default value

freshrss_extensions_enabled:
  - Tumblr-GDPR

freshrss_extra_hosts

Default value

freshrss_extra_hosts: []

freshrss_healthcheck

Default value

freshrss_healthcheck:
  test: '["CMD", "/usr/local/bin/healthcheck.sh"]'
  interval: 30s
  timeout: 5s
  retries: 5

freshrss_image

Default value

freshrss_image: xoxys/freshrss:{{ freshrss_version }}

freshrss_language

Default value

freshrss_language: en

freshrss_limits_cache_duration

Default value

freshrss_limits_cache_duration: '800'

freshrss_limits_cookie_duration

Default value

freshrss_limits_cookie_duration: '2592000'

freshrss_limits_max_categories

Default value

freshrss_limits_max_categories: '16384'

freshrss_limits_max_feeds

Default value

freshrss_limits_max_feeds: '16384'

freshrss_limits_max_inactivity

Default value

freshrss_limits_max_inactivity: '10800'

freshrss_limits_max_registrations

Default value

freshrss_limits_max_registrations: '1'

freshrss_limits_timeout

Default value

freshrss_limits_timeout: '15'

freshrss_memory_limit

Default value

freshrss_memory_limit: _unset_

Example usage

freshrss_memory_limit: 512m

freshrss_memory_reservation

Default value

freshrss_memory_reservation: _unset_

Example usage

freshrss_memory_reservation: 256m

freshrss_meta_description

Default value

freshrss_meta_description: _unset_

freshrss_pids_limit

Default value

freshrss_pids_limit: _unset_

freshrss_pubsubhubbub_enabled

Default value

freshrss_pubsubhubbub_enabled: 'false'

freshrss_restart_policy

Default value

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

freshrss_salt: _unset_

freshrss_security_opt

Default value

freshrss_security_opt: []

freshrss_service_directory

Default value

freshrss_service_directory: /var/lib/docker/services/freshrss

freshrss_simplepie_syslog_enabled

Default value

freshrss_simplepie_syslog_enabled: 'true'

freshrss_title

Default value

freshrss_title: FreshRSS

freshrss_unsafe_autologin_enabled

Default value

freshrss_unsafe_autologin_enabled: 'false'

freshrss_version

Default value

freshrss_version: latest

Dependencies

None.

License

MIT

Author

xoxys