From 65717f66ca3e115cede73cf183f8ae7869c2fc8c Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Wed, 6 Jun 2018 15:49:38 -0600 Subject: [PATCH] Update documentation to mention where to get the Docker image This is assuming that it actually ends up on docker.io Signed-off-by: Travis Ralston --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae81e08..039dbd7 100644 --- a/README.md +++ b/README.md @@ -225,7 +225,12 @@ sensible-browser http://localhost:6060/pkg/github.com/matrix-org/go-neb ## Docker image -There is a `Dockerfile` in the root of the repository which copies the local source files and builds go-neb. +To get started quickly, use the image from docker.io: +``` +docker run -v /path/to/data:/data -e "BASE_URL=http://your.public.url:4050" matrixdotorg/go-neb +``` + +If you'd prefer to build the file yourself, clone this repository and build the `Dockerfile`. The image sets the following environment variables: ```