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/1/head
LinuxServer-CI 2019-02-12 14:25:45 +00:00
rodzic 80c3ae7708
commit a9679b1b93
1 zmienionych plików z 106 dodań i 54 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

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

@ -1,88 +1,140 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/freshrss](https://github.com/linuxserver/docker-freshrss)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://freshrss.org/
[hub]: https://hub.docker.com/r/linuxserver/freshrss/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/freshrss.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-freshrss/master)](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)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [Freshrss](https://freshrss.org/) is a free, self-hostable aggregator for rss feeds.
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/freshrss ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/freshrss.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-freshrss)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-freshrss/)
[FreshRSS][appurl] is a free, self-hostable aggregator for rss feeds 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).
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 |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
[![freshrss](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/freshrss-banner.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=freshrss \ --name=freshrss \
-v <path to data>:/config \ -e PUID=1001 \
-e PGID=<gid> -e PUID=<uid> \ -e PGID=1001 \
-p 80:80 \ -e TZ=Europe/London \
linuxserver/freshrss -p 80:80 \
-v <path to data>:/config \
--restart unless-stopped \
linuxserver/freshrss
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
freshrss:
image: linuxserver/freshrss
container_name: freshrss
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
ports:
- 80:80
mem_limit: 4096m
restart: unless-stopped
``` ```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. 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.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `80` | WebUI |
* `-p 80` - the port(s) ### Environment Variables (`-e`)
* `-v /config` - local storage for freshrss site files
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it freshrss /bin/bash`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
### User / Group Identifiers ### Volume Mappings (`-v`)
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. | Volume | Function |
| :----: | --- |
| `/config` | Local storage for freshrss site files. |
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
## 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=1001` and `PGID=1001`, to find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application ## 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.
## Info
* To monitor the logs of the container in realtime `docker logs -f freshrss`.
* container version number ## Support Info
`docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss` * Shell access whilst the container is running:
* `docker exec -it freshrss /bin/bash`
* image version number * To monitor the logs of the container in realtime:
* `docker logs -f freshrss`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/freshrss` * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/freshrss`
## Versions ## Versions
+ **14.01.19:** Add multi arch and pipeline logic. * **14.01.19:** - Add multi arch and pipeline logic.
+ **05.09.18:** Rebase to alpine linux 3.8. * **05.09.18:** - Rebase to alpine linux 3.8.
+ **17.03.18:** Update nginx config to resolve api not working. * **17.03.18:** - Update nginx config to resolve api not working.
+ **08.01.18:** Rebase to alpine linux 3.7. * **08.01.18:** - Rebase to alpine linux 3.7.
+ **25.05.17:** Rebase to alpine linux 3.6. * **25.05.17:** - Rebase to alpine linux 3.6.
+ **23.02.17:** Rebase to alpine linux 3.5 and nginx. * **23.02.17:** - Rebase to alpine linux 3.5 and nginx.
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer information.
+ **08.10.16:** Add Sqlite support for standalone operation. * **08.10.16:** - Add Sqlite support for standalone operation.
+ **27.09.16:** Fix for cron job. * **27.09.16:** - Fix for cron job.
+ **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.