2020-04-28 15:23:37 +00:00
# linuxserver/freshrss
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-freshrss.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-freshrss) [![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-freshrss.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-freshrss/releases) [![GitHub Package Repository ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-freshrss/packages) [![GitLab Container Registry ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF )](https://gitlab.com/Linuxserver.io/docker-freshrss/container_registry) [![Quay.io ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io )](https://quay.io/repository/linuxserver.io/freshrss) [![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/freshrss.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/freshrss) [![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/freshrss.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/freshrss) [![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/freshrss.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/freshrss) [![Build Status ](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-freshrss/job/master/badge/icon?style=flat-square )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-freshrss/job/master/) [![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/freshrss/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/freshrss/latest/index.html)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
[Freshrss ](https://freshrss.org/ ) is a free, self-hostable aggregator for rss feeds.
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
## Supported Architectures
2019-02-10 06:39:04 +00:00
2019-09-01 05:38:01 +00:00
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 ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-12 14:25:45 +00:00
Simply pulling `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 |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-02-12 14:25:45 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 21:04:30 +00:00
| armhf | arm32v7-latest |
2019-02-10 06:39:04 +00:00
## Usage
2019-02-12 14:25:45 +00:00
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-04-28 15:23:37 +00:00
```text
2019-02-10 06:39:04 +00:00
docker create \
2019-02-12 14:25:45 +00:00
--name=freshrss \
2019-03-03 06:37:46 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-12 14:25:45 +00:00
-e TZ=Europe/London \
-p 80:80 \
2020-03-31 20:55:43 +00:00
-v /path/to/data:/config \
2019-02-12 14:25:45 +00:00
--restart unless-stopped \
linuxserver/freshrss
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-09 11:33:15 +00:00
version: "2.1"
2019-02-12 14:25:45 +00:00
services:
freshrss:
image: linuxserver/freshrss
container_name: freshrss
environment:
2019-03-03 06:37:46 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:25:45 +00:00
- TZ=Europe/London
volumes:
2020-03-31 20:55:43 +00:00
- /path/to/data:/config
2019-02-12 14:25:45 +00:00
ports:
- 80:80
restart: unless-stopped
2019-02-10 06:39:04 +00:00
```
## Parameters
2020-04-28 15:23:37 +00:00
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.
2019-02-12 14:25:45 +00:00
2020-04-28 15:23:37 +00:00
### Ports \(`-p`\)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
| Parameter | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-02-12 14:25:45 +00:00
| `80` | WebUI |
2019-02-10 06:39:04 +00:00
2020-04-28 15:23:37 +00:00
### Environment Variables \(`-e`\)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
| Env | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-03-03 06:37:46 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:25:45 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-10 06:39:04 +00:00
2020-04-28 15:23:37 +00:00
### Volume Mappings \(`-v`\)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
| Volume | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-02-12 14:25:45 +00:00
| `/config` | Local storage for freshrss site files. |
## User / Group Identifiers
2020-04-28 15:23:37 +00:00
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` .
2019-02-12 14:25:45 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-03 06:37:46 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-10 06:39:04 +00:00
2020-04-28 15:23:37 +00:00
```text
2019-02-12 14:25:45 +00:00
$ id username
2019-03-03 06:37:46 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-10 06:39:04 +00:00
```
2019-02-12 14:25:45 +00:00
## Application Setup
2019-02-10 06:39:04 +00:00
2020-03-31 20:55:43 +00:00
Access the webui set up wizard at `http://serverIP:port`
2020-04-28 15:23:37 +00:00
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.
2020-03-31 20:55:43 +00:00
Additional extensions can be dropped into `/config/www/freshrss/extensions` and will be active after container restart.
2019-10-06 05:39:10 +00:00
2020-04-09 11:33:15 +00:00
## Docker Mods
2020-04-28 15:23:37 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27freshrss%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml )](https://mods.linuxserver.io/?mod=freshrss)
2020-04-09 11:33:15 +00:00
2020-04-28 15:23:37 +00:00
We publish various [Docker Mods ](https://github.com/linuxserver/docker-mods ) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
## Support Info
2019-02-10 06:39:04 +00:00
2019-09-01 05:38:01 +00:00
* Shell access whilst the container is running:
2019-02-12 14:25:45 +00:00
* `docker exec -it freshrss /bin/bash`
2019-09-01 05:38:01 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:25:45 +00:00
* `docker logs -f freshrss`
2019-09-01 05:38:01 +00:00
* Container version number
2019-02-12 14:25:45 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/freshrss`
2019-02-10 06:39:04 +00:00
## Versions
2020-03-31 20:55:43 +00:00
* **31.03.20:** - Internalize app and enable updates for existing users, allow user customized crontab.
2019-12-20 21:05:46 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-07-06 17:59:03 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 21:04:30 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 17:27:26 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-12 14:25:45 +00:00
* **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.
2020-04-28 15:23:37 +00:00