Skip to content

README.md

Latest commit

 

History

History
49 lines (33 loc) · 3.16 KB

README.md

File metadata and controls

49 lines (33 loc) · 3.16 KB
Raw

FreshRSS

FreshRSS is an RSS and Atom feed reader that you host yourself. It supports themes and extensions, and its Google Reader and Fever compatible API lets mobile and desktop clients synchronise with your server.

This stack runs FreshRSS with a Tailscale sidecar, as described in the standard setup.

At a glance

Item Value
Web interface https://freshrss.<tailnet>.ts.net
Service port 80
Image freshrss/freshrss
Data ./freshrss-data/app/data (configuration and database)
./freshrss-data/app/extensions (extensions)

Before you start

Set these values in .env before the first start. FreshRSS uses them only while its data folder is empty.

  • TAILNET_NAME. Your Tailnet name with .ts.net. compose.yaml builds the base address of FreshRSS as https://<SERVICE>.<TAILNET_NAME>.
  • ADMIN_USERNAME, ADMIN_PASSWORD, and ADMIN_EMAIL. The administrator account.
  • ADMIN_API_PASSWORD. The password for clients that use the API.

Do not use $, backticks, or backslashes in these values.

Deviations from the standard setup

  • Unattended installation. FRESHRSS_INSTALL and FRESHRSS_USER in compose.yaml install FreshRSS with SQLite and create the administrator at the first start. On later starts, FreshRSS reports FreshRSS already installed; no change performed. and ignores .env.
  • Trusted proxy. TRUSTED_PROXY=127.0.0.1 makes FreshRSS accept the client address that Tailscale Serve forwards.
  • Feed updates. CRON_MIN in .env sets the minutes of each hour at which FreshRSS refreshes the feeds.
  • Health check. The health check runs ./cli/health.php, which requests /api/. If you disable the API in the web interface, the container reports unhealthy although the web interface works.

First run

Open the web interface and log in with the administrator account from .env. Change the passwords in the web interface from now on, not in .env.

Configuration

  • Change the base address. FreshRSS shows the base address read-only under Configuration > System. To change it after the first start, run docker compose exec application ./cli/reconfigure.php --base-url https://freshrss.<tailnet>.ts.net.
  • Local network access. The ports block stays commented out. If you enable it, the stack publishes plain HTTP on port 80 of the Docker host, which is often in use.
  • MagicDNS. TS_ACCEPT_DNS=true is only needed if FreshRSS itself must resolve MagicDNS names, such as an external database. The default SQLite setup does not need it.

Links