aboutsummaryrefslogtreecommitdiff
path: root/Docker
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2018-12-18 09:05:39 +0100
committerGravatar GitHub <noreply@github.com> 2018-12-18 09:05:39 +0100
commitc78be1371edaaa2c687b17597795803db2988b4b (patch)
treeb52299f9d357522aacbf924e6c7a89a523962f95 /Docker
parent66f59278922bdd8ae2eca105a628b9724a88a380 (diff)
Update Docker readme (#2189)
* Update Docker readme Promote the use of an automated reverse proxy such as Træfik. Propose other good practices. * Typo
Diffstat (limited to 'Docker')
-rw-r--r--Docker/README.md172
1 files changed, 111 insertions, 61 deletions
diff --git a/Docker/README.md b/Docker/README.md
index cdc6429fa..6745de141 100644
--- a/Docker/README.md
+++ b/Docker/README.md
@@ -3,6 +3,7 @@
* https://hub.docker.com/r/freshrss/freshrss/
* https://cloud.docker.com/app/freshrss/repository/docker/freshrss/freshrss
+
## Install Docker
```sh
@@ -10,9 +11,10 @@ curl -fsSL https://get.docker.com/ -o get-docker.sh
sh get-docker.sh
```
+
## Optional: Build Docker image of FreshRSS
Optional, as a *less recent* online image can be automatically fetched during the next step (run),
-but online images are not available for as many platforms as if you build yourself.
+but online images are not available for as many platforms (e.g. Raspberry Pi / ARM) as if you build yourself.
```sh
# First time only
@@ -24,53 +26,109 @@ sudo docker pull alpine:3.8
sudo docker build --tag freshrss/freshrss -f Docker/Dockerfile .
```
-## Run FreshRSS
-
-Example using SQLite, built-in cron, and exposing FreshRSS on port 8080. You may have to adapt the parameters to fit your needs.
+## Create an isolated network
```sh
-# You can optionally run from the directory containing the FreshRSS source code:
-cd ./FreshRSS/
+sudo docker network create freshrss-network
+```
+
+## Recommended: use [Træfik](https://traefik.io/) reverse proxy
+It is a good idea to use a reverse proxy on your host server, providing HTTPS.
+Here is the recommended configuration using automatic [Let’s Encrypt](https://letsencrypt.org/) HTTPS certificates and with a redirection from HTTP to HTTPS. See further below for alternatives.
-# The data will be saved on the host in `./data/`
-mkdir -p ./data/
+```sh
+sudo docker volume create traefik-letsencrypt
+# Just change your e-mail address in the command below:
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
- -v $(pwd)/data:/var/www/FreshRSS/data \
- -e 'CRON_MIN=5,35' \
- -p 8080:80 \
- --name freshrss freshrss/freshrss
+ -v traefik-letsencrypt:/etc/traefik/acme \
+ -v /var/run/docker.sock:/var/run/docker.sock:ro \
+ --net freshrss-network \
+ -p 80:80 \
+ -p 443:443 \
+ --name traefik traefik --docker \
+ --entryPoints='Name:http Address::80 Compress:true Redirect.EntryPoint:https' \
+ --entryPoints='Name:https Address::443 Compress:true TLS TLS.MinVersion:VersionTLS12 TLS.SniStrict:true TLS.CipherSuites:TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' \
+ --defaultentrypoints=http,https \
+ --acme=true --acme.entrypoint=https --acme.onhostrule=true --acme.tlsChallenge --acme.storage=/etc/traefik/acme/acme.json \
+ --acme.email=you@example.net
```
-### Examples with external databases
+See [more information about Docker and Let’s Encrypt in Træfik](https://docs.traefik.io/user-guide/docker-and-lets-encrypt/).
-You may want to use other link methods such as Docker bridges, and use Docker volumes for the data, but here are some simple examples:
-#### MySQL
-See https://hub.docker.com/_/mysql/
+## Run FreshRSS
+Example using a dedicated domain (rules based on sub-folders are also possible in Træfik), and the built-in refresh cron job (see further below for alternatives).
+For this configuration, you must first create your domain or sub-domain `freshrss.example.net`.
```sh
-sudo docker run -d -v /path/to/mysql-data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=rootpass -e MYSQL_DATABASE=freshrss -e MYSQL_USER=freshrss -e MYSQL_PASSWORD=pass --name mysql mysql
+sudo docker volume create freshrss-data
+
+# Remember to replace freshrss.example.net by your server address in the command below:
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
- -v $(pwd)/data:/var/www/FreshRSS/data \
- -e 'CRON_MIN=17,47' \
- --link mysql -p 8080:80 \
+ -v freshrss-data:/var/www/FreshRSS/data \
+ -e 'CRON_MIN=4,34' \
+ --net freshrss-network \
+ --label traefik.port=80 \
+ --label traefik.frontend.rule='Host:freshrss.example.net' \
+ --label traefik.frontend.headers.forceSTSHeader=true \
+ --label traefik.frontend.headers.STSSeconds=31536000 \
--name freshrss freshrss/freshrss
```
-#### PostgreSQL
-See https://hub.docker.com/_/postgres/
+* Add `-p 8080:80 \` if you want to expose FreshRSS locally, e.g. on port `8080`.
+* You can remove the `--label traefik.*` lines if you do not use Træfik.
+This already works with a built-in **SQLite** database (easiest), but more powerful databases are supported:
+
+### [MySQL](https://hub.docker.com/_/mysql/)
```sh
-sudo docker run -d -v /path/to/pgsql-data:/var/lib/postgresql/data -e POSTGRES_DB=freshrss -e POSTGRES_USER=freshrss -e POSTGRES_PASSWORD=pass --name postgres postgres
+# If you already have a MySQL instance running, just attach it to the FreshRSS network:
+sudo docker network connect freshrss-network mysql
+
+# Otherwise, start a new MySQL instance, remembering to change the passwords:
+sudo docker volume create mysql-data
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
- -v $(pwd)/data:/var/www/FreshRSS/data \
- -e 'CRON_MIN=23,53' \
- --link postgres -p 8080:80 \
- --name freshrss freshrss/freshrss
+ -v mysql-data:/var/lib/mysql \
+ -e MYSQL_ROOT_PASSWORD=rootpass
+ -e MYSQL_DATABASE=freshrss \
+ -e MYSQL_USER=freshrss \
+ -e MYSQL_PASSWORD=pass \
+ --net freshrss-network \
+ --name mysql mysql
+```
+
+### [PostgreSQL](https://hub.docker.com/_/postgres/)
+```sh
+# If you already have a PostgreSQL instance running, just attach it to the FreshRSS network:
+sudo docker network connect freshrss-network postgres
+
+# Otherwise, start a new PostgreSQL instance, remembering to change the passwords:
+sudo docker volume create pgsql-data
+sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
+ -v pgsql-data:/var/lib/postgresql/data \
+ -e POSTGRES_DB=freshrss \
+ -e POSTGRES_USER=freshrss \
+ -e POSTGRES_PASSWORD=pass \
+ --net freshrss-network \
+ --name postgres postgres
+```
+
+### Complete installation
+Browse to your server https://freshrss.example.net/ to complete the installation via the FreshRSS Web interface,
+or use the command line described below.
+
+
+## Command line
+
+```sh
+sudo docker exec --user apache -it freshrss php ./cli/list-users.php
```
-## Update
+See the [CLI documentation](../cli/) for all the other commands.
+
+
+## How to update
```sh
# Rebuild an image (see build section above) or get a new online version:
@@ -79,35 +137,43 @@ sudo docker pull freshrss/freshrss
sudo docker stop freshrss
sudo docker rename freshrss freshrss_old
# See the run section above for the full command
-sudo docker run ...
+sudo docker run ... --name freshrss freshrss/freshrss
# If everything is working, delete the old container
sudo docker rm freshrss_old
```
-## Command line
+
+## Debugging
```sh
-sudo docker exec --user apache -it freshrss php ./cli/list-users.php
+# See FreshRSS data if you use Docker volume
+sudo docker volume inspect freshrss-data
+sudo ls /var/lib/docker/volumes/freshrss-data/_data/
+
+# See Web server logs
+sudo docker logs -f freshrss
+
+# Enter inside FreshRSS docker container
+sudo docker exec -it freshrss sh
+## See FreshRSS root inside the container
+ls /var/www/FreshRSS/
```
-See the [CLI documentation](../cli/) for all the other commands.
## Cron job to automatically refresh feeds
We recommend a refresh rate of about twice per hour (see *WebSub* / *PubSubHubbub* for real-time updates).
-There is no less than 3 options. Pick a single one.
+There are no less than 3 options. Pick a single one.
### Option 1) Cron inside the FreshRSS Docker image
-Easiest, built-in solution, also used in the examples above
+Easiest, built-in solution, also used already in the examples above
(but your Docker instance will have a second process in the background, without monitoring).
Just pass the environment variable `CRON_MIN` to your `docker run` command,
containing a valid cron minute definition such as `'13,43'` (recommended) or `'*/20'`.
Not passing the `CRON_MIN` environment variable – or setting it to empty string – will disable the cron daemon.
```sh
-sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
- -v $(pwd)/data:/var/www/FreshRSS/data \
+sudo docker run ... \
-e 'CRON_MIN=13,43' \
- -p 8080:80 \
--name freshrss freshrss/freshrss
```
@@ -129,32 +195,15 @@ See cron option 1 for customising the cron schedule.
```sh
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
- -v $(pwd)/data:/var/www/FreshRSS/data \
+ -v freshrss-data:/var/www/FreshRSS/data \
-e 'CRON_MIN=17,37' \
+ --net freshrss-network \
--name freshrss_cron freshrss/freshrss \
crond -f -d 6
```
-## Debugging
-
-```sh
-# See FreshRSS data (it is on the host)
-cd ./data/
-# See Web server logs
-sudo docker logs -f freshrss
-
-# Enter inside FreshRSS docker container
-sudo docker exec -it freshrss sh
-## See FreshRSS root inside the container
-ls /var/www/FreshRSS/
-```
-
-## Deployment in production
-
-Use a reverse proxy on your host server, such as [Træfik](https://traefik.io/)
-or [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/),
-with HTTPS, for instance using [Let’s Encrypt](https://letsencrypt.org/).
+## More deployment options
### Example with [docker-compose](https://docs.docker.com/compose/)
@@ -167,14 +216,15 @@ A [docker-compose.yml](docker-compose.yml) file is given as an example, using Po
* options under the `labels` section are specific to [Træfik](https://traefik.io/), a reverse proxy. If you are not using it, feel free to delete this section. If you are using it, adapt accordingly to your config, especially the `traefik.frontend.rule` option.
* the `environment` section to adapt the strategy to update feeds.
-You can then launch the stack (postgres + freshrss) with:
+You can then launch the stack (FreshRSS + PostgreSQL) with:
```sh
-docker-compose up -d
+sudo docker-compose up -d
```
-### Nginx reverse proxy configuration
+### Alternative reverse proxy using [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/)
-Here is an example of configuration to run FreshRSS behind an Nginx reverse proxy (as subdirectory). In particular, the proxy should be setup to allow cookies via HTTP headers (see `proxy_cookie_path` below) to allow logging in via the Web form method.
+Here is an example of configuration to run FreshRSS behind an Nginx reverse proxy (as subdirectory).
+In particular, the proxy should be setup to allow cookies via HTTP headers (see `proxy_cookie_path` below) to allow logging in via the Web form method.
```
upstream freshrss {