docker-documentation/docs/images/docker-freshrss.md

300 wiersze
12 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-18 12:41:45 +00:00
---
title: freshrss
---
2023-10-08 13:00:38 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-freshrss/blob/master/.github/CONTRIBUTING.md -->
2020-07-05 05:39:28 +00:00
# [linuxserver/freshrss](https://github.com/linuxserver/docker-freshrss)
2021-12-23 12:48:46 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Ffreshrss?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Ffreshrss)
2020-07-05 05:39:28 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-freshrss.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-freshrss)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-freshrss.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-freshrss/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-freshrss/packages)
2020-12-15 19:41:34 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-freshrss/container_registry)
2021-10-07 12:48:32 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/freshrss)
2020-07-05 05:39:28 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/freshrss.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/freshrss)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/freshrss)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-freshrss%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-freshrss/job/master/)
2020-11-02 15:16:01 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Ffreshrss%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/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
2023-10-08 13:00:38 +00:00
[![freshrss](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/freshrss-banner.png)](https://freshrss.org/)
2019-02-12 14:25:45 +00:00
## Supported Architectures
2019-02-10 06:39:04 +00:00
2023-11-19 01:13:45 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#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
2022-05-05 12:58:54 +00:00
Simply pulling `lscr.io/linuxserver/freshrss:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-12 14:25:45 +00:00
The architectures supported by this image are:
2022-05-05 12:58:54 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-05-31 12:27:07 +00:00
| armhf | ❌ | |
2019-02-10 06:39:04 +00:00
2021-04-22 12:52:55 +00:00
## 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.
2020-07-05 05:39:28 +00:00
2019-02-10 06:39:04 +00:00
## Usage
2021-07-08 12:48:14 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-02-12 14:25:45 +00:00
2021-07-08 12:48:14 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-02-12 14:25:45 +00:00
```yaml
---
services:
freshrss:
2022-05-05 12:58:54 +00:00
image: lscr.io/linuxserver/freshrss:latest
2019-02-12 14:25:45 +00:00
container_name: freshrss
environment:
2019-03-03 06:37:46 +00:00
- PUID=1000
- PGID=1000
2023-02-16 12:49:44 +00:00
- TZ=Etc/UTC
2019-02-12 14:25:45 +00:00
volumes:
2024-01-26 16:42:01 +00:00
- /path/to/freshrss/config:/config
2019-02-12 14:25:45 +00:00
ports:
- 80:80
restart: unless-stopped
2019-02-10 06:39:04 +00:00
```
2021-07-08 12:48:14 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-04 05:38:44 +00:00
2021-04-22 12:52:55 +00:00
```bash
2020-10-04 05:38:44 +00:00
docker run -d \
--name=freshrss \
-e PUID=1000 \
-e PGID=1000 \
2023-02-16 12:49:44 +00:00
-e TZ=Etc/UTC \
2020-10-04 05:38:44 +00:00
-p 80:80 \
2024-01-26 16:42:01 +00:00
-v /path/to/freshrss/config:/config \
2020-10-04 05:38:44 +00:00
--restart unless-stopped \
2022-05-05 12:58:54 +00:00
lscr.io/linuxserver/freshrss:latest
2020-10-04 05:38:44 +00:00
```
2019-02-10 06:39:04 +00:00
## Parameters
2023-10-08 13:00:38 +00:00
Containers 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-07-05 05:39:28 +00:00
### Ports (`-p`)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
| Parameter | Function |
2020-07-05 05:39:28 +00:00
| :----: | --- |
2019-02-12 14:25:45 +00:00
| `80` | WebUI |
2019-02-10 06:39:04 +00:00
2020-07-05 05:39:28 +00:00
### Environment Variables (`-e`)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
| Env | Function |
2020-07-05 05:39:28 +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 |
2023-02-16 12:49:44 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2019-02-10 06:39:04 +00:00
2020-07-05 05:39:28 +00:00
### Volume Mappings (`-v`)
2019-02-10 06:39:04 +00:00
2019-02-12 14:25:45 +00:00
| Volume | Function |
2020-07-05 05:39:28 +00:00
| :----: | --- |
2024-01-26 16:42:01 +00:00
| `/config` | Persistent config files |
2019-02-12 14:25:45 +00:00
2021-10-07 12:48:32 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-05 05:39:28 +00:00
## Environment variables from files (Docker secrets)
2020-05-30 13:32:55 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-22 12:52:55 +00:00
```bash
2023-10-08 13:00:38 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-05-30 13:32:55 +00:00
```
2023-10-08 13:00:38 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-05-30 13:32:55 +00:00
## Umask for running applications
2020-07-05 05:39:28 +00:00
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-12 14:25:45 +00:00
## User / Group Identifiers
2020-07-05 05:39:28 +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.
2023-10-08 13:00:38 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-02-10 06:39:04 +00:00
2021-04-22 12:52:55 +00:00
```bash
2023-10-08 13:00:38 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-02-10 06:39:04 +00:00
```
2020-04-09 11:33:15 +00:00
## Docker Mods
2021-04-22 12:52:55 +00:00
2020-10-04 05:38:44 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=freshrss&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 "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-09 11:33:15 +00:00
2020-10-04 05:38:44 +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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-09 11:33:15 +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:
2023-10-08 13:00:38 +00:00
```bash
docker exec -it freshrss /bin/bash
```
2019-09-01 05:38:01 +00:00
* To monitor the logs of the container in realtime:
2023-10-08 13:00:38 +00:00
```bash
docker logs -f freshrss
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/freshrss:latest
```
## Updating Info
2024-01-14 13:03:40 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
2023-10-08 13:00:38 +00:00
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull freshrss
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d freshrss
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/freshrss:latest
```
* Stop the running container:
```bash
docker stop freshrss
```
* Delete the container:
```bash
docker rm freshrss
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-freshrss.git
cd docker-freshrss
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/freshrss:latest .
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-02-10 06:39:04 +00:00
## Versions
2024-01-26 16:42:01 +00:00
* **23.12.23:** - Rebase to Alpine 3.19 with php 8.3.
2023-05-31 12:27:07 +00:00
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
2023-04-17 17:30:23 +00:00
* **13.04.23:** - Move ssl.conf include to default.conf.
2023-03-16 12:48:04 +00:00
* **02.03.23:** - Split cron into separate init step and set crontab permissions.
2023-01-20 14:16:49 +00:00
* **19.01.23:** - Rebase to alpine 3.17 with php8.1.
2022-10-22 01:23:59 +00:00
* **21.10.22:** - Fix cron init to properly migrate existing installations to new app location.
2022-10-19 13:33:18 +00:00
* **20.08.22:** - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)).
2021-02-10 16:22:51 +00:00
* **23.01.21:** - Rebasing to alpine 3.13.
2020-06-03 20:47:03 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
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.