astopy/passbolt repository overview

       ____                  __          ____          .-.
      / __ \____  _____ ____/ /_  ____  / / /_    .--./ /      _.---.,
     / /_/ / __ `/ ___/ ___/ __ \/ __ \/ / __/     '-,  (__..-`       \
    / ____/ /_/ (__  |__  ) /_/ / /_/ / / /_          \                |
   /_/    \__,_/____/____/_,___/\____/_/\__/           `,.__.   ^___.-/
                                                         `-./ .'...--`
  The open source password manager for teams                `'
  (c) 2018 Passbolt SARL
  https://www.passbolt.com

⁠What is passbolt?

Passbolt is a free and open source password manager that allows team members to store and share credentials securely.

⁠Requirements:

• rng-tools or haveged are required on host machine to speed up entropy generation on containers. This way gpg key creation on passbolt container will be faster.
• mariadb/mysql >= 5.0

⁠Usage

Users are encouraged to use official docker image from the docker hub⁠.

⁠Start passbolt instance

Passbolt requires mysql to be running. The following example use mysql official docker image with the default passbolt credentials.

$ docker run -e MYSQL_ROOT_PASSWORD=<root_password> \
             -e MYSQL_DATABASE=<mysql_database> \
             -e MYSQL_USER=<mysql_user> \
             -e MYSQL_PASSWORD=<mysql_password> \
             mysql

Then you can start passbolt just by providing the database container ip in the db_host environment variable.

$ docker run --name passbolt \
             -e DATASOURCES_DEFAULT_HOST=<mysql_container_host> \
             -e DATASOURCES_DEFAULT_PASSWORD=<mysql_password> \
             -e DATASOURCES_DEFAULT_USERNAME=<mysql_user> \
             -e DATASOURCES_DEFAULT_DATABASE=<mysql_database> \
             -e APP_FULL_BASE_URL=https://mydomain.com \
             passbolt/passbolt:develop-debian

Once the container is running create your first admin user:

$ docker exec passbolt su -m -c "/var/www/passbolt/bin/cake passbolt register_user -u [email protected] -f yourname -l surname -r admin" -s /bin/sh www-data

This registration command will return a single use url required to continue the web browser setup and finish the registration. Your passbolt instance should be available browsing https://yourdomain.com

⁠Configure passbolt

⁠Environment variables reference

Passbolt docker image provides several environment variables to configure different aspects:

For more env variables supported please check default.php⁠ For more env variables supported please check app.default.php⁠

⁠Configuration files

What if you already have a set of gpg keys and custom configuration files for passbolt? It it possible to mount the desired configuration files as volumes.

• /var/www/passbolt/config/app.php
• /var/www/passbolt/config/passbolt.php
• /var/www/passbolt/config/gpg/serverkey.asc
• /var/www/passbolt/config/gpg/serverkey_private.asc
• /var/www/passbolt/webroot/img/public/images

⁠SSL certificate files

It is also possible to mount a ssl certificate on the following paths:

• /etc/ssl/certs/certificate.crt
• /etc/ssl/certs/certificate.key

⁠docker-compose

Usage:

$ docker-compose up

⁠Requirements:

• rng-tools or haveged are required on host machine to speed up entropy generation on containers. This way gpg key creation on passbolt container will be faster.
• mysql >= 5.6