From 434826b99bab4d1d0e931cf7e478badf1a395243 Mon Sep 17 00:00:00 2001 From: Andy Postnikov Date: Fri, 29 Jul 2016 20:01:28 +0300 Subject: [PATCH] Document KANBAN_ENABLE_SIGNUP variable This variable used in `docker-compose.yml` but not documented --- README.md | 2 ++ docs/installation/docker.md | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb79bad..4d175e8 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ Go to https://gitlab.com/profile/applications or your GitLab installation and re > `KANBAN_GITLAB_CLIENT` | Your GitLab OAuth client application ID, required for OAuth to work. Git this from your gitlab server. > > `KANBAN_GITLAB_SECRET` | Your GitLab OAuth client secret key, required for OAuth to work. Git this from your gitlab server. +> +> `KANBAN_ENABLE_SIGNUP` | Wheter to enable sign up with user API token. **Then** diff --git a/docs/installation/docker.md b/docs/installation/docker.md index 3a31244..78a9d72 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -88,7 +88,8 @@ The LeanLabs Kanban image requires Redis, which [we are also providing](https:// -e KANBAN_GITLAB_CLIENT="Application ID" -e KANBAN_GITLAB_SECRET="Secret" -e KANBAN_REDIS_ADDR="kanban_redis:6379" - leanlabs/kanban:1.4.0 + -e KANBAN_ENABLE_SIGNUP="true" + leanlabs/kanban:1.6.2 ``` Now you should be able to access kanban via GitLab OAuth. @@ -129,6 +130,8 @@ If you use a self hosted GitLab installation the value must also include the pro You may also use a unix socket, if you set address as "unix:///path/to/sock.sock". LeanLabs Kanban requires the Redis server to function properly, it stores users identities there. +- **KANBAN_ENABLE_SIGNUP** - default to "true". Wheter to enable sign up with user API token. + - **KANBAN_REDIS_PASSWORD** - default to "" (empty string). The Redis server password if any. - **KANBAN_REDIS_DB** - default to "0", redis server database numeric index, from 0 to 16, also rarely required to be changed if ever. -- GitLab