Docker passbolt installation

System requirements

docker: https://docs.docker.com/get-docker/
docker-compose: https://docs.docker.com/compose/install/
A Linux user able to run docker commands without sudo
a working SMTP server for email notifications
a working NTP service to avoid GPG authentication issues

FAQ pages:

docker-compose

The easiest and recommended way to deploy your passbolt stack is to use docker-compose.

Step 1. Download our docker-compose.yml example file

curl -Ls https://raw.githubusercontent.com/passbolt/passbolt_docker/master/docker-compose/docker-compose-ce.yaml -o docker-compose.yaml

Step 2. Ensure the file has not been corrupted by verifying its shasum

$ shasum -a 256 docker-compose.yaml

Must return:

3ff1cb219ae028293ba29f808d0ed17695aeb69a3baa9399194c214881f6409e  docker-compose.yaml

Warning: If the shasum command output is not correct, the downloaded file has been corrupted. Retry step 1 or ask for support on our community forum.

Step 3. Configure environment variables in docker-compose.yaml file to customize your instance.

The APP_FULL_BASE_URL environment variable is set by default to https://passbolt.local, using a self-signed certificate.

Update this variable with the server name you plan to use. You will find at the bottom of this documentation links about how to set your own SSL certificate.

You must configure also SMTP settings to be able to receive notifications and recovery emails. Please find below the most used environment variables for this purpose:

Variable name	Description	Default value
EMAIL_DEFAULT_FROM_NAME	From email username	`'Passbolt'`
EMAIL_DEFAULT_FROM	From email address	`'[email protected]'`
EMAIL_TRANSPORT_DEFAULT_HOST	Server hostname	`'localhost'`
EMAIL_TRANSPORT_DEFAULT_PORT	Server port	`25`
EMAIL_TRANSPORT_DEFAULT_USERNAME	Username for email server auth	`null`
EMAIL_TRANSPORT_DEFAULT_PASSWORD	Password for email server auth	`null`
EMAIL_TRANSPORT_DEFAULT_TLS	Set tls	`null`

For more information on which environment variables are available on passbolt, please check the passbolt environment variable reference.

Step 4. Start your containers

docker-compose up -d

Step 5. Create first admin user

$ docker-compose exec passbolt su -m -c "/usr/share/php/passbolt/bin/cake \
                                passbolt register_user \
                                -u <[email protected]> \
                                -f <yourname> \
                                -l <surname> \
                                -r admin" -s /bin/sh www-data

It will output a link similar to the below one that can be pasted on the browser to finalize user registration:

https://my.domain.tld/setup/install/1eafab88-a17d-4ad8-97af-77a97f5ff552/f097be64-3703-41e2-8ea2-d59cbe1c15bc

At this point, you should have a working docker setup running on the latest tag. However, it is recommended that users pull the tags pointing to specific passbolt versions when running in environments other than testing.