freshrss

About

FreshRSS is a self-hosted RSS feed aggregator

• Github
• Documentation
• Docker Image

Table of Contents

• About
• Table of Contents
• Information
  • docker-compose
• Usage
  • Requirements
  • Configuration
• Update
• Backup

.
|-- .env
|-- data/
`-- docker-compose.yml

• .env - a file containing all the environment variables used in the docker-compose.yml
• docker-compose.yml - a docker-compose file, use to configure your application’s services
• data/ - a directory used to store the data

Please make sure that all the files and directories are present.

Information

docker-compose

Links to the following docker-compose.yml and the corresponding .env.

• docker-compose.yml

  version: '3'
  
  services:
  freshrss:
      image: 'freshrss/freshrss'
      container_name: freshrss
      restart: unless-stopped
      volumes:
        - "./data:/var/www/FreshRSS/data"
      environment:
        - 'CRON_MIN=4,34'
        - 'TZ=Europe/Paris'
      networks:
        - proxy
      labels:
        - "traefik.enable=true"
        - "traefik.http.routers.webserver.rule=Host(`${TRAEFIK_FRESHRSS}`)"
        - "traefik.http.routers.webserver.entrypoints=https"
        - "traefik.http.routers.webserver.tls=true"
        - "traefik.http.routers.webserver.tls.certresolver=mydnschallenge"
        # Watchtower Update
        - "com.centurylinklabs.watchtower.enable=true"
  
  networks:
    proxy:
      external: true

• .env

  TRAEFIK_FRESHRSS=freshrss.example.com
  TZ=Europe/Paris

The docker-compose contains only one service using the freshrss image.

Usage

Requirements

• Traefik up and running.
• A subdomain of your choice, this example uses freshrss.
  • You should be able to create a subdomain with your DNS provider, use a A record with the same IP address as your root domain.

Configuration

Replace the environment variables in .env with your own, then run :

sudo docker-compose up -d

You should now be able to access the freshrss setup instruction, it is quite straigthforward and nothing is required.

Update

The image is automatically updated with watchtower thanks to the following label :

  # Watchtower Update
  - "com.centurylinklabs.watchtower.enable=true"

Backup

Docker volumes are globally backed up using borg-backup.