From 84bae14b5e3bf1a41875eea720fe527398823d99 Mon Sep 17 00:00:00 2001 From: emil-lengman Date: Wed, 12 Aug 2020 22:30:44 +0200 Subject: [PATCH] add documentation for the docker solution --- readme.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/readme.md b/readme.md index 3b001d4..b719190 100644 --- a/readme.md +++ b/readme.md @@ -47,6 +47,16 @@ $ yarn setup $ yarn dev ``` +#### Using docker-compose + +Just run the following: + +``` +$ docker-compose up +``` + +This will automatically create the default `.env` files, and run redis for you. + ### Production Create server and client production builds @@ -61,6 +71,22 @@ Start server $ yarn start ``` +#### Using Docker + +Build it. + +``` +$ docker build --tag darkwire.io:latest . +``` + +Then run it. Example: + +``` +$ docker run --name darkwire.io --env STORE_HOST=redis://redis.host:6379 darkwire.io +``` + +You are able to use any of the enviroment variables available in `server/.env.dist` and `client/.env.dist`. The defaults are available in [Dockerfile](Dockerfile) + ### Security Please report any security issues to `hello@darkwire.io`.