From 6e0a3689b87ae7544aad49a5c91df2341a8018ca Mon Sep 17 00:00:00 2001 From: adan-ea <57812567+adan-ea@users.noreply.github.com> Date: Wed, 18 Sep 2024 09:54:54 +0200 Subject: [PATCH] doc: add info about docker compose Should clarify and help close #1321 Issue also found in #1169 and #334 where i found my solution --- docs/installation.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index d0cae448..ed089aa4 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -26,7 +26,7 @@ hub](https://hub.docker.com/r/ihatemoney/ihatemoney/). This is probably the simplest way to get something running. Once you have Docker installed on your system, just issue : - docker run -d -p 8000:8000 ihatemoney/ihatemoney + docker run -d -p 8000:8000 ihatemoney/ihatemoney:latest Ihatemoney is now available on . @@ -62,12 +62,18 @@ Add these additional environment variables to the docker run invocation: -e ACTIVATE_ADMIN_DASHBOARD=True \ -e ADMIN_PASSWORD= \ +:::{note} +If you are using a `docker-compose.yml` file and need to include a password hash, use `$$` instead of `$` to escape the dollar sign. This ensures that the hash is treated as a literal string rather than a variable in Bash. +::: + Additional gunicorn parameters can be passed using the docker `CMD` parameter. For example, use the following command to add more gunicorn workers: docker run -d -p 8000:8000 ihatemoney/ihatemoney -w 3 +If needed, there is a `docker-compose.yml` file available as an example on the [project github repository](https://github.com/spiral-project/ihatemoney/blob/master/docker-compose.yml) + (cloud)= ## On a Cloud Provider