mash-playbook/docs/services/freshrss.md

1.9 KiB

FreshRSS

FreshRSS is a self-hosted RSS and Atom feed aggregator. It is lightweight, easy to work with, powerful, and customizable.

Dependencies

This service requires the following other services:

  • a Traefik reverse-proxy server
  • an optional Postgres database, but FreshRSS will default to SQLite if you don't have Postgres enabled.

Configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# freshrss                                                             #
#                                                                      #
########################################################################

freshrss_enabled: true

freshrss_hostname: mash.example.com
freshrss_path_prefix: /freshrss

# Put a strong password below, generated with `pwgen -s 64 1` or in another way.
# You will need to use this password in the setup wizard after installation.
freshrss_database_password: ''

########################################################################
#                                                                      #
# /freshrss                                                            #
#                                                                      #
########################################################################

Usage

After installation, visit the configured path and complete the setup through the wizard. To do this you will need the database password from your vars.yml file (in the freshrss_database_password variable).

Feel free to follow FreshRSS official documentation.