Skip to content

Commit ea1fce2

Browse files
hroemersolidnerd
authored andcommitted
Documentation update on Docker config and secrets file env and example fix (sameersbn#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
1 parent 7ca29df commit ea1fce2

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1072,7 +1072,13 @@ and then both docker-compose and Docker Swarm can import them into your gitlab c
10721072

10731073
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).
10741074

1075-
See the exmample `config/docker-swarm/docker-compose.yml` file, and the example `gitlab.config` and `gitlab.secrets` file.
1075+
See the example [`contrib/docker-swarm/docker-compose.yml`](./contrib/docker-swarm/docker-compose.yml) file, and the
1076+
example `gitlab.configs` and `gitlab.secrets` file.
1077+
You may as well choose file names other than the example source files (`gitlab.configs` and `gitlab.secrets`) and update
1078+
the `file: ./gitlab.configs` and `file: ./gitlab.secrets` references accordingly. But do not alter the config
1079+
keys [`gitlab-configs`](contrib/docker-swarm/docker-compose.yml#L158) and
1080+
[`gitlab-secrets`](contrib/docker-swarm/docker-compose.yml#L162) as they are currently
1081+
[hardcoded](./assets/runtime/functions#L4:L9) and thus must be kept as in the example.
10761082

10771083
If you're not using one of these files, then don't include its entry in the docker-compose file.
10781084

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)