aboutsummaryrefslogtreecommitdiff
path: root/Docker/README.md
diff options
context:
space:
mode:
authorGravatar Upils <paulmars@orange.fr> 2018-05-09 09:57:46 +0200
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2018-05-09 09:57:46 +0200
commit0ccda74571fd314864ce0223ed1efaae26a11ca8 (patch)
treec98e585acc8bf18cd937e4b20fad1f4f92fb25a4 /Docker/README.md
parentbde96ec8ea32d153d1d3d6263299f6b073f34f9e (diff)
Add a docker compose example. (#1882)
* Add a docker compose example. Using postgresql and with traefik specific labels. * Added docker-compose specific documentation. * Move docker-compose section at the end of the README.md.
Diffstat (limited to 'Docker/README.md')
-rw-r--r--Docker/README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/Docker/README.md b/Docker/README.md
index 1767ae85d..c333329d4 100644
--- a/Docker/README.md
+++ b/Docker/README.md
@@ -75,7 +75,7 @@ sudo docker run -d --restart unless-stopped --log-opt max-size=10m \
```sh
# Rebuild an image (see build section above) or get a new online version:
sudo docker pull freshrss/freshrss
-# And then
+# And then
sudo docker stop freshrss
sudo docker rename freshrss freshrss_old
# See the run section above for the full command
@@ -155,3 +155,18 @@ ls /var/www/FreshRSS/
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/).
+
+### Example with [docker-compose](https://docs.docker.com/compose/)
+
+A `docker-compose.yml` file is given as an example, using PostgreSQL. In order to use it, you have to adapt:
+- In the `postgresql` service:
+ * the `volumes` section;
+ * the `POSTGRES_PASSWORD` in the `environment` section;
+- In the `freshrss` service:
+ * the `volumes` section;
+ * 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.
+
+You can then launch the stack (postgres + freshrss) with:
+```sh
+docker-compose up -d
+```