From ea1fce2c4bbaa71411e7340fe2a57c0cc0f5f498 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hannes=20R=C3=B6mer?= <16097755+hroemer@users.noreply.github.com> Date: Thu, 26 Sep 2019 06:26:12 +0200 Subject: [PATCH] Documentation update on Docker config and secrets file env and example fix (#1980) * fixed typos in referenced config and secret files * updated documentation on external configs and secrets and added note on hard-coded config keys * updated documentation link to sample config * updated documentation link to sample config * updated documentation links to config keys * updated documentation links to config keys * updated documentation links to config keys --- README.md | 8 +++++++- contrib/docker-swarm/{gitlab.config => gitlab.configs} | 0 contrib/docker-swarm/{gitlab.secret => gitlab.secrets} | 0 3 files changed, 7 insertions(+), 1 deletion(-) rename contrib/docker-swarm/{gitlab.config => gitlab.configs} (100%) rename contrib/docker-swarm/{gitlab.secret => gitlab.secrets} (100%) diff --git a/README.md b/README.md index 16dec1e3..bf454b4f 100644 --- a/README.md +++ b/README.md @@ -1072,7 +1072,13 @@ and then both docker-compose and Docker Swarm can import them into your gitlab c On startup, the gitlab container will source env vars from a config file labeled `gitlab-config`, and then a secrets file labeled `gitlab-secrets` (both mounted in the default locations). -See the exmample `config/docker-swarm/docker-compose.yml` file, and the example `gitlab.config` and `gitlab.secrets` file. +See the example [`contrib/docker-swarm/docker-compose.yml`](./contrib/docker-swarm/docker-compose.yml) file, and the +example `gitlab.configs` and `gitlab.secrets` file. +You may as well choose file names other than the example source files (`gitlab.configs` and `gitlab.secrets`) and update +the `file: ./gitlab.configs` and `file: ./gitlab.secrets` references accordingly. But do not alter the config +keys [`gitlab-configs`](contrib/docker-swarm/docker-compose.yml#L158) and +[`gitlab-secrets`](contrib/docker-swarm/docker-compose.yml#L162) as they are currently +[hardcoded](./assets/runtime/functions#L4:L9) and thus must be kept as in the example. If you're not using one of these files, then don't include its entry in the docker-compose file. diff --git a/contrib/docker-swarm/gitlab.config b/contrib/docker-swarm/gitlab.configs similarity index 100% rename from contrib/docker-swarm/gitlab.config rename to contrib/docker-swarm/gitlab.configs diff --git a/contrib/docker-swarm/gitlab.secret b/contrib/docker-swarm/gitlab.secrets similarity index 100% rename from contrib/docker-swarm/gitlab.secret rename to contrib/docker-swarm/gitlab.secrets