mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-06 01:39:10 -04:00
rodzic 48f5bffbc9
commit feb9f8222a
1 zmienionych plików z 27 dodań i 15 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

42
images/docker-freshrss.md
Wyświetl plik

@ -1,6 +1,12 @@
# linuxserver/freshrss # [linuxserver/freshrss](https://github.com/linuxserver/docker-freshrss)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-freshrss.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-freshrss/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/freshrss.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/freshrss) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/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)](https://hub.docker.com/r/linuxserver/freshrss) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg?style=flat-square&color=E68523)](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) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-freshrss.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-freshrss/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/freshrss.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/freshrss "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/freshrss.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/freshrss "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/freshrss.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/freshrss)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg?style=flat-square&color=E68523)](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)
[Freshrss](https://freshrss.org/) is a free, self-hostable aggregator for rss feeds. [Freshrss](https://freshrss.org/) is a free, self-hostable aggregator for rss feeds.
@ -13,18 +19,19 @@ Simply pulling `linuxserver/freshrss` should retrieve the correct image for your
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=freshrss \ --name=freshrss \
-e PUID=1000 \ -e PUID=1000 \
@ -36,6 +43,7 @@ docker create \
linuxserver/freshrss linuxserver/freshrss
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -60,44 +68,49 @@ services:
## Parameters ## 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. 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`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `80` | WebUI | | `80` | WebUI |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Local storage for freshrss site files. | | `/config` | Local storage for freshrss site files. |
## User / Group Identifiers ## 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`. 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. 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: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
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. 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.
## Support Info ## Support Info
@ -127,4 +140,3 @@ Create a user and database in your mysql/mariadb server \(not root\) and then fo
* **11.09.16:** - Add layer badges to README. * **11.09.16:** - Add layer badges to README.
* **23.11.15:** - Update dependencies to latest requirements. * **23.11.15:** - Update dependencies to latest requirements.
* **21.08.15:** - Initial Release. * **21.08.15:** - Initial Release.