Skip to content
Scrumlr Docs

Docker Compose

Scrumlr can be deployed using a Docker Compose file. This is the easiest way to get started with Scrumlr. We maintain a Docker Compose file in our Repository that you can use to deploy Scrumlr.

Prerequisites

Clone the Scrumlr repository to your server and navigate to the deployment directory.

Terminal window
git clone https://github.com/inovex/scrumlr.io
cd scrumlr.io/deployment/

Copy the .env.example file to .env and adjust the variables to your needs.

Terminal window
cp .env.example .env

Generating needed secrets

Postgres Password

Generate a secure password for the Postgres database. Make sure to set the POSTGRES_PASSWORDvariable in your .env file to the generated password.

Terminal window
pwgen -s 64 1

JWT Private Key

We use an ECDSA private key to sign the JWT tokens. Make sure to keep this key secure as it can be used to decrypt the tokens and generate new ones, potentially compromising your users’ accounts.

Terminal window
openssl ecparam -genkey -name secp521r1 -noout -out jwt.key

Now we need to encode this key to be able to use it as a string in the .env file.

Terminal window
cat jwt.key | awk '{printf "%s\\n", $0}'

Deployment

You can now start the deployment using the following command.

Terminal window
docker-compose up -d

Reverse Proxy

We strongly recommend using a reverse proxy to handle TLS termination and to provide a secure connection to your users. Scrumlr should work with all major reverse proxies like Nginx, Traefik, or Caddy. We automatically include a caddy deployment in the docker-compose file, which you can use as a reverse proxy. All you need to do is updating the Caddyfile to include your host domain instead of 0.0.0.0:80. If you dont want TLS you can simply keep the specified port. Keep in mind that running Scrumlr without TLS is not recommended.

your_domain {
}