From 2aea1691cf33b7d9e03fbe2c711af7d8f76d9724 Mon Sep 17 00:00:00 2001 From: kolaente Date: Sat, 13 Nov 2021 18:08:57 +0100 Subject: [PATCH] docs: add postgres to docker-compose examples --- docs/content/doc/setup/full-docker-example.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/content/doc/setup/full-docker-example.md b/docs/content/doc/setup/full-docker-example.md index 2a9020bb..6dc221c2 100644 --- a/docs/content/doc/setup/full-docker-example.md +++ b/docs/content/doc/setup/full-docker-example.md @@ -25,6 +25,9 @@ All examples on this page already reflect this and do not require additional wor ## Redis +While Vikunja has support to use redis as a caching backend, you'll probably not need it unless you're using Vikunja +with more than a handful of users. + To use redis, you'll need to add this to the config examples below: {{< highlight yaml >}} @@ -44,6 +47,29 @@ services: image: redis {{< /highlight >}} +## PostgreSQL + +Vikunja supports postgres, mysql and sqlite as a database backend. The examples on this page use mysql with a mariadb container. +To use postgres as a database backend, change the `db` section of the examples to this: + +{{< highlight yaml >}} +db: + image: postgres:13 + environment: + POSTGRES_PASSWORD: secret + POSTGRES_USER: vikunja + volumes: + - ./db:/var/lib/postgresql/data + restart: unless-stopped +{{< /highlight >}} + +You'll also need to change the `VIKUNJA_DATABASE_TYPE` to `postgres` on the api container declaration. + +
+NOTE: The mariadb container can sometimes take a while to initialize, especially on the first run. +During this time, the api container will fail to start at all. It will automatically restart every few seconds. +
+ ## Example without any proxy This example lets you host Vikunja without any reverse proxy in front of it. This is the absolute minimum configuration