Skip to content

Commit 6292c57

Browse files
committed
Update REDMINE_SECRET_KEY_BASE usage/description
1 parent c125332 commit 6292c57

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

redmine/content.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,11 @@ This variable allows you to control if `rake redmine:plugins:migrate` is run on
112112

113113
`redmine:plugins:migrate` will not run if you start your image with something other than the default `CMD`, like `bash`. See the current `docker-entrypoint.sh` in your image for details.
114114

115-
### `REDMINE_SECRET_KEY_BASE`
115+
### `SECRET_KEY_BASE`
116116

117-
This variable is required when using Docker Swarm replicas to maintain session connections when being loadbalanced between containers. It will create an initial `config/secrets.yml` and set the `secret_key_base` value, which is "used by Rails to encode cookies storing session data thus preventing their tampering. Generating a new secret token invalidates all existing sessions after restart" ([session store](https://www.redmine.org/projects/redmine/wiki/RedmineInstall#Step-5-Session-store-secret-generation)). If you do not set this variable or provide a `secrets.yml` one will be generated using `rake generate_secret_token`.
117+
This is a general Rails environment variable. This variable is useful when using loadbalanced replicas to maintain session connections. It is "used by Rails to encode cookies storing session data thus preventing their tampering. Generating a new secret token invalidates all existing sessions after restart" ([session store](https://www.redmine.org/projects/redmine/wiki/RedmineInstall#Step-5-Session-store-secret-generation)). If you do not set this variable, then the `secret_key_base` value will be generated using `rake generate_secret_token`.
118+
119+
For backwards compatibility, the deprecated, docker-specific `REDMINE_SECRET_KEY_BASE` variable will automatically fill the `SECRET_KEY_BASE` environment variable. Users should migrate their deployments to use the `SECRET_KEY_BASE` variable directly.
118120

119121
## Running as an arbitrary user
120122

0 commit comments

Comments
 (0)