From 067a720aa5efcecae95a0a1d9b094f134feed9e9 Mon Sep 17 00:00:00 2001 From: Tobias Trabelsi Date: Sun, 25 Jun 2017 16:11:19 +0200 Subject: [PATCH] Added Docker deployment documentation in README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index bf8dbb8..96f4c33 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,23 @@ make clean build bin/lgtm -h ``` +### Docker + +A Docker Image is available for easy deployment. It can be run locally or on a dedicated Server as follows: + +``` +docker run --name lgtm -v /my/host/path:/var/lib/lgtm:z -e GITHUB_CLIENT= -e GITHUB_SECRET= -p 8000:8000 gitea/lgtm +``` + +To Fill the Environment Variables `GITHUB_CLIENT` and `GITHUB_SECRET`, create new OAuth Application [here](https://github.com/settings/applications/new) + +* Homepage URL = protocol://host:port (f.e. http://localhost:8000) +* Authorization callback URL = protocol://host:port/login (f.e. http://localhost:8000/login) + + +To Build the Image by yourself please refere to the [Dockerfile](https://github.com/go-gitea/lgtm/blob/master/Dockerfile) and the [Drone Configuration](https://github.com/go-gitea/lgtm/blob/master/.drone.yml). + + ## Contributing Fork -> Patch -> Push -> Pull Request