github/openproject-deploy
1
0
Fork 0
mirror of https://github.com/opf/openproject-deploy.git synced 2026-07-12 06:59:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README with SECRET_KEY_BASE details

Browse Source 
Added information about SECRET_KEY_BASE requirement and its implications.
This commit is contained in:
Oliver Günther
2026-05-13 08:25:46 +02:00
committed by GitHub
parent 53cb620e18
commit e9e1e12cbb
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -32,13 +32,15 @@ sudo chown 1000:1000 -R /var/openproject/assets
Next you start up the containers in the background while making sure to pull the latest versions of all used images.
```shell
OPENPROJECT_HTTPS=false docker compose up -d --build --pull always
SECRET_KEY_BASE=OVERWRITE_ME OPENPROJECT_HTTPS=false docker compose up -d --build --pull always
```
After a while, OpenProject should be up and running on `http://localhost:8080`. The default username and password is login: `admin`, and password: `admin`.
The `OPENPROJECT_HTTPS=false` environment variable explicitly disables HTTPS mode for the first startup. Without this, OpenProject assumes it's running behind HTTPS in production by default.
We do strongly recommend you use OpenProject behind a TLS terminated proxy for production purposes and remove this flag before actually starting to use it.
You will also need to provide a secure key for the `SECRET_KEY_BASE`, it should be unique and treated like a password.
This value is used to derive keys for the Rails application. Changing this value will invalidate all cookies, including sessions and 2FA remembering tokens.
### Customization
The `docker-compose.yml` file present in the repository can be adjusted to your convenience. But note that with each pull, it will be overwritten.