Skip to main content

Backup and Recovery

Introduction​

Regular backups are essential for protecting your passbolt data. This section covers backup procedures for different deployment methods.

Backup Methods​

Choose the backup method that matches your deployment:

  • From Docker - Backup procedures for Docker deployments
  • From Packages - Backup procedures for package-based installations
  • From Sources - Backup procedures for source-based installations

What to Backup​

A complete passbolt backup should include:

  1. Database - All user data, resources, and configuration
  2. GPG Server Keys - Server encryption keys (public and private)
  3. Configuration Files - Application and server configuration
  4. TLS Certificates - SSL/TLS certificates if applicable

Recovery​

The database is restored with the mysql_import command, the counterpart of the sql_export used for backups. The procedure, with the right command for your installation, is on the same pages as the backup steps:

After restoring a backup, ensure:

  • Database is restored to the correct location
  • GPG server keys are restored with correct permissions, and imported into the keyring of the web server user with passbolt keyring_init
  • Configuration files match the backup state
  • TLS certificates are valid and properly configured

Finish with passbolt healthcheck to confirm the instance is consistent.