Skip to content

FreshRSS

FreshRSS is an RSS feed reader.

There is no official image for this service, so we'll use ghcr.io/linuxserver/freshrss.

Pre-Installation

We'll create a folder in the main user's home where all the service's data will be saved.

mkdir ~/services/media/freshrss

Docker Compose

FreshRSS will be run using Docker Compose. The content of the docker-compose.yml file is as follows:

services:
  web:
    image: ghcr.io/linuxserver/freshrss:latest
    restart: unless-stopped
    networks:
      default:
      proxy_external:
        aliases:
          - freshrss
    volumes:
      - ./data:/config
    environment:
      TZ: America/Guayaquil
      PUID: 1000
      PGID: 1000
    labels:
      traefik.enable: true
      traefik.docker.network: proxy_external
      traefik.http.routers.freshrss.rule: Host(`subdomain.example.com`)
      traefik.http.routers.freshrss.entrypoints: tunnel
      traefik.http.routers.freshrss.service: freshrss@docker
      traefik.http.services.freshrss.loadbalancer.server.port: 80

networks:
  proxy_external:
    external: true

Note

In the case of the PUID and PGID environment variables, 1000 corresponds to the user's UID and GID respectively. You can find the values for your own user by running id $whoami.

Note

Replace subdomain.example.com with the domain name where your service will be accessible from.

Reverse Proxy

This service is exposed by a reverse proxy. More specifically, it is using Traefik.

For this reason, you will see that this service has:

  1. A directive to connect it to the proxy_external external network.
  2. A container alias for the proxy_external network.
  3. A number of labels with names starting with traefik.

If you're not using a reverse proxy, feel free to remove these from the docker-compose.yml file. Keep in mind you might need to bind the ports to connect to the service instead.

Running

Start up the service with:

docker compose up -d

That's it! The service will auto-start on system startup and restart on failure.