Docker readme cleanups (#2483)

* Don't manually pull the base image

* Remove sudo before each docker

cause the user is usually added to the docker group

If not you can read it up here:
https://docs.docker.com/install/linux/linux-postinstall/

* Simplify cd
pull/2494/head
Sandro 5 years ago committed by Alexandre Alapetite
parent de26531178
commit 544fcc4500
  1. 57
      Docker/README.md

@ -17,7 +17,7 @@ sh get-docker.sh
## Create an isolated network
```sh
sudo docker network create freshrss-network
docker network create freshrss-network
```
## Recommended: use [Træfik](https://traefik.io/) reverse proxy
@ -25,11 +25,11 @@ 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.
```sh
sudo docker volume create traefik-letsencrypt
sudo docker volume create traefik-tmp
docker volume create traefik-letsencrypt
docker volume create traefik-tmp
# Just change your e-mail address in the command below:
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
docker run -d --restart unless-stopped --log-opt max-size=10m \
-v traefik-letsencrypt:/etc/traefik/acme \
-v traefik-tmp:/tmp \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
@ -55,10 +55,10 @@ You must first chose a domain (DNS) or sub-domain, e.g. `freshrss.example.net`.
> **N.B.:** Default images are for x64 (Intel, AMD) platforms. For ARM (e.g. Raspberry Pi), use the `*-arm` tags. For other platforms, see the section *Build Docker image* further below.
```sh
sudo docker volume create freshrss-data
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 \
docker run -d --restart unless-stopped --log-opt max-size=10m \
-v freshrss-data:/var/www/FreshRSS/data \
-e 'CRON_MIN=4,34' \
-e TZ=Europe/Paris \
@ -82,11 +82,11 @@ This already works with a built-in **SQLite** database (easiest), but more power
### [MySQL](https://hub.docker.com/_/mysql/)
```sh
# If you already have a MySQL instance running, just attach it to the FreshRSS network:
sudo docker network connect freshrss-network mysql
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 \
docker volume create mysql-data
docker run -d --restart unless-stopped --log-opt max-size=10m \
-v mysql-data:/var/lib/mysql \
-e MYSQL_ROOT_PASSWORD=rootpass
-e MYSQL_DATABASE=freshrss \
@ -99,11 +99,11 @@ sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
### [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
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 \
docker volume create pgsql-data
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 \
@ -121,14 +121,14 @@ or use the command line described below.
```sh
# Rebuild an image (see build section above) or get a new online version:
sudo docker pull freshrss/freshrss
docker pull freshrss/freshrss
# And then
sudo docker stop freshrss
sudo docker rename freshrss freshrss_old
docker stop freshrss
docker rename freshrss freshrss_old
# See the run section above for the full command
sudo docker run ... --name freshrss freshrss/freshrss
docker run ... --name freshrss freshrss/freshrss
# If everything is working, delete the old container
sudo docker rm freshrss_old
docker rm freshrss_old
```
@ -153,17 +153,16 @@ Note that prebuilt images are less recent and only available for x64 (Intel, AMD
# First time only
git clone https://github.com/FreshRSS/FreshRSS.git
cd ./FreshRSS/
cd FreshRSS/
git pull
sudo docker pull ubuntu:18.10
sudo docker build --tag freshrss/freshrss -f Docker/Dockerfile .
docker build --pull --tag freshrss/freshrss -f Docker/Dockerfile .
```
## Command line
```sh
sudo docker exec --user apache -it freshrss php ./cli/list-users.php
docker exec --user apache -it freshrss php ./cli/list-users.php
```
See the [CLI documentation](../cli/) for all the other commands.
@ -173,14 +172,14 @@ See the [CLI documentation](../cli/) for all the other commands.
```sh
# See FreshRSS data if you use Docker volume
sudo docker volume inspect freshrss-data
docker volume inspect freshrss-data
sudo ls /var/lib/docker/volumes/freshrss-data/_data/
# See Web server logs
sudo docker logs -f freshrss
docker logs -f freshrss
# Enter inside FreshRSS docker container
sudo docker exec -it freshrss sh
docker exec -it freshrss sh
## See FreshRSS root inside the container
ls /var/www/FreshRSS/
```
@ -198,7 +197,7 @@ containing a valid cron minute definition such as `'13,43'` (recommended) or `'*
Not passing the `CRON_MIN` environment variable – or setting it to empty string – will disable the cron daemon.
```sh
sudo docker run ... \
docker run ... \
-e 'CRON_MIN=13,43' \
--name freshrss freshrss/freshrss
```
@ -221,7 +220,7 @@ See cron option 1 for customising the cron schedule.
#### For the Ubuntu image (default)
```sh
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
docker run -d --restart unless-stopped --log-opt max-size=10m \
-v freshrss-data:/var/www/FreshRSS/data \
-e 'CRON_MIN=17,47' \
--net freshrss-network \
@ -231,7 +230,7 @@ sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
#### For the Alpine image
```sh
sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
docker run -d --restart unless-stopped --log-opt max-size=10m \
-v freshrss-data:/var/www/FreshRSS/data \
-e 'CRON_MIN=27,57' \
--net freshrss-network \
@ -248,7 +247,7 @@ Changes in Apache `.htaccess` files are applied when restarting the container.
In particular, if you want FreshRSS to use HTTP-based login (instead of the easier Web form login), you can mount your own `./FreshRSS/p/i/.htaccess`:
```
sudo docker run ...
docker run ...
-v /your/.htaccess:/var/www/FreshRSS/p/i/.htaccess \
-v /your/.htpasswd:/var/www/FreshRSS/data/.htpasswd \
...
@ -276,7 +275,7 @@ A [docker-compose.yml](docker-compose.yml) file is given as an example, using Po
You can then launch the stack (FreshRSS + PostgreSQL) with:
```sh
sudo docker-compose up -d
docker-compose up -d
```
### Alternative reverse proxy using [nginx](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/)

Loading…
Cancel
Save