Skip to content

Commit fe88a30

Browse files
readme: add a section to explain docker-compose
Explains how to debug the container in case one is using it to develop locally.
1 parent 9d4e6df commit fe88a30

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,14 @@ In order to build a docker image, run the following in the root directory:
5959

6060
Just use `docker-compose up` and you're good to go.
6161

62+
Or `docker-compose up -d` if you're running it on a server in a detached state.
63+
64+
You can then find your container ID by checking `docker container ls`.
65+
66+
Which could then be used to e.g. check the container logs with `docker container logs <ID>`.
67+
68+
If you're developing locally, you can replace the path to the image with your own image tag, e.g. `matrix/waterfall`.
69+
6270
#### Hard Way
6371

6472
To run the image from the current directory assuming that there is a `config.yaml`:

0 commit comments

Comments
 (0)