____                  __          ____
     / __ \____  _____ ____/ /_  ____  / / /_
    / /_/ / __ `/ ___/ ___/ __ \/ __ \/ / __/
   / ____/ /_/ (__  |__  ) /_/ / /_/ / / /_
  /_/    \__,_/____/____/_,___/\____/_/\__/

The open source password manager for teams
Copyright (c) 2025 Passbolt SA
https://www.passbolt.com

📘 Looking for the official documentation?
You can find the full and up-to-date documentation for this repository on our help guides:
👉 Community Edition Documentation
👉 Pro Edition Documentation

We strongly recommend referring to it for setup instructions, configuration details, and troubleshooting tips.

## Ansible Galaxy modules

You can install the required Ansible Galaxy modules using the following command:

ansible-galaxy collection install -r requirements.yml

Variables

Database configuration

Name	Default value	Allowed values	Mandatory?	Description
database_configuration.dbname	passbolt_db	String	❌	The name of the Passbolt database.
database_configuration.username	passbolt_db_user	String	❌	The name of the Passbolt database user.
database_configuration.host	null	String representing an IP or a FQDN	❌	The database host. Anything other than null will be treated as an external database (thus disabling database installation and creation)
database_configuration.password		String	✅	The password for the Passbolt database user.

NGINX configuration

Name	Default value	Allowed values	Mandatory?	Description
nginx_configuration.fqdn	passbolt.local	String	❌	The Fully-Qualified Domain Name for your Passbolt server, without any http or https schema.
nginx_configuration.certbot_email		String	❌	The e-mail to provide to certbot for certificates renewal and other notifications. *By providing this e-mail, this ansible playbook will accept the TOS.
nginx_configuration.manual_certificate.fullchain_certificate		String	❌	The fullchain certificate content when using manually generated certificates.
nginx_configuration.manual_certificate.private_key		String	❌	The private key content when using manually generated certificates.

Passbolt configuration

Variable	Default	Type	Mandatory	Edition	Description
passbolt_configuration.gpg_name	Passbolt default server key	string	❌	ALL	“Real name” field for the server’s GPG key.
passbolt_configuration.gpg_email	server@nginx_configuration.fqdn	string	❌	ALL	“Email” field for the server’s GPG key.
passbolt_configuration.subscription_key		string	✅	PRO	Base64-encoded subscription key (only for PRO edition).
passbolt_configuration.admin_email		string	✅	ALL	Email address of the initial administrator.
passbolt_configuration.admin_firstname		string	✅	ALL	First name of the initial administrator.
passbolt_configuration.admin_lastname		string	✅	ALL	Last name of the initial administrator.