Search…
Images
Powered By GitBook
linuxserver/freshrss
Freshrss is a free, self-hostable aggregator for rss feeds.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/freshrss should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

Access the webui set up wizard at http://serverIP:port
For external databases, create a user and database in your mysql/mariadb server (not root) and then follow the setup wizard in the webui. Use the IP address for "host" of your database server.
Additional extensions can be dropped into /config/www/freshrss/extensions and will be active after container restart.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
freshrss:
5
image: lscr.io/linuxserver/freshrss
6
container_name: freshrss
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- /path/to/data:/config
13
ports:
14
- 80:80
15
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=freshrss \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-p 80:80 \
7
-v /path/to/data:/config \
8
--restart unless-stopped \
9
lscr.io/linuxserver/freshrss
Copied!

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter
Function
80
WebUI

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume
Function
/config
Local storage for freshrss site files.

Miscellaneous Options

Parameter
Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

    Shell access whilst the container is running:
      docker exec -it freshrss /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f freshrss
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/freshrss

Versions

    23.01.21: - Rebasing to alpine 3.13.
    01.06.20: - Rebasing to alpine 3.12.
    31.03.20: - Internalize app and enable updates for existing users, allow user customized crontab.
    19.12.19: - Rebasing to alpine 3.11.
    28.06.19: - Rebasing to alpine 3.10.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    22.02.19: - Rebasing to alpine 3.9.
    14.01.19: - Add multi arch and pipeline logic.
    05.09.18: - Rebase to alpine linux 3.8.
    17.03.18: - Update nginx config to resolve api not working.
    08.01.18: - Rebase to alpine linux 3.7.
    25.05.17: - Rebase to alpine linux 3.6.
    23.02.17: - Rebase to alpine linux 3.5 and nginx.
    14.10.16: - Add version layer information.
    08.10.16: - Add Sqlite support for standalone operation.
    27.09.16: - Fix for cron job.
    11.09.16: - Add layer badges to README.
    23.11.15: - Update dependencies to latest requirements.
    21.08.15: - Initial Release.
Last modified 20d ago