Passbolt Community Edition

Deploy Passbolt Community Edition, an open source password manager for teams and businesses. Use it to securely store, share, and manage credentials in a self-hosted environment.

Note: Passbolt and the Passbolt logo are registered trademarks of Passbolt S.A. This service is provided by Akamai and is not affiliated with Passbolt S.A.

1. Deploy Passbolt Community Edition

 Estimated deployment time: 5–10 minutes

Follow the deployment instructions from the Get started section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the Configuration options section.

Base distribution and plan

  • Supported distribution: Ubuntu 24.04 LTS
  • Recommended plans: For best results, use a 4GB Dedicated CPU or Shared CPU Compute Instance.

Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (stackscript_data) required for automated deployments.

StackScript ID: 1439640

.
UI fieldAPI/CLI keyDescription
Required options
Limited sudo user user_name Your preferred username for the limited sudo user entered without any capital letters, spaces, or special characters.
When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.
Note: For easier and more secure access with the sudo user, add an account SSH key for the Cloud Manager user during deployment and select that user as an authorized_user. Their SSH pubkey will be assigned to both the root and limited user.
DomaindomainApplies to a custom domain. The domain name for your Passbolt instance, like example.com.
Linode API token token_password Applies to a custom domain. The Linode API token if you want to use Linode’s DNS Manager to manage DNS records for your custom domain. Follow Manage personal access tokens to get your token on your account with Read/Write access to Domains.
  • If you provide the token along with the subdomain and domain, the installation attempts to create DNS records via the Linode API.
  • If you don't provide the token, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.
Email address (for the Let's Encrypt SSL certificate)soa_email_addressYour email address to use for generating SSL certificates.
Passbolt user first namepassbolt_user_firstnameThe first name for the initial Passbolt administrator user.
Passbolt user last namepassbolt_user_lastnameThe last name for the initial Passbolt administrator user.
Passbolt user email addresspassbolt_user_emailThe email address for the initial Passbolt administrator user.
Advanced options
Disable root access over SSH disable_root Applies to a limited sudo user. To block the root user from logging in over SSH, select Yes. Defaults to No.
Note: When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the authorized_user, you can still switch to the root user. To do that, log in as root via the Lish console and run cat /home/$USERNAME/.credentials to view the generated password for the limited sudo user.
SubdomainsubdomainApplies to a custom domain. The subdomain you want to use for the DNS record, like blog for blog.example.com. Defaults to www. Use it only if you specify a Domain.
Optional data exporter Add-onsadd_onsAn option to include add-ons for your deployment. Possible values are:
  • none (default)
  • newrelic
  • node_exporter
  • mysqld_exporter

Notes:

  • After the app deployment completes, the password for your limited sudo user is generated and stored in the .credentials file in the home directory, along with application-specific passwords. Log in to your instance as root through the Lish console or SSH, then run cat /home/$USERNAME/.credentials to view its contents.
  • You can automatically configure a custom domain (optional) during deployment. To do that:
    1. First, configure your domain to use Linode’s name servers via your registrar. See Configure your domain's authoritative name servers for details.
    2. Once you complete that, specify the Linode API token, subdomain, and domain for the app in Cloud Manager or via API/CLI/Terraform.

Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and app-specific fields along with the standard Linode deployment configurations.

Note: Generate a personal access token to authenticate your API, CLI, or Terraform requests.

curl --location 'https://api.linode.com/v4/linode/instances' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer abc123def456hij789klm' \
  --data-raw '{
    "region": "us-east",
    "type": "g6-standard-2",
    "image": "linode/ubuntu24.04",
    "label": "my-passbolt-one-click-app",
    "root_pass": "@C0mpl3x#P@ssw0rd",
    "stackscript_id": 1439640,
    "stackscript_data": {
        "domain": "example.com",
        "token_password": "abc123def456hij789klm",
        "soa_email_address": "jsmith@example.com",
        "passbolt_user_firstname": "John",
        "passbolt_user_lastname": "Smith",
        "passbolt_user_email": "admin@example.com",
        "user_name": "jsmith"
    }
  }'
linode-cli linodes create \
  --region us-east \
  --type g6-standard-2 \
  --label my-passbolt-one-click-app \
  --image linode/ubuntu24.04 \
  --root_pass @C0mpl3x#P@ssw0rd \
  --stackscript_id 1439640 \
  --stackscript_data '{"domain":"example.com", "token_password":"abc123def456hij789klm", "soa_email_address":"jsmith@example.com", "passbolt_user_firstname":"John", "passbolt_user_lastname":"Smith", "passbolt_user_email":"admin@example.com", "user_name":"jsmith"}'
resource "linode_instance" "my-linode" {
  region         = "us-east"
  type           = "g6-standard-2"
  label          = "my-passbolt-one-click-app"
  image          = "linode/ubuntu24.04"
  root_pass      = "@C0mpl3x#P@ssw0rd"
  stackscript_id = 1439640
  stackscript_data = {
    "domain"                  = "example.com"
    "token_password"          = "abc123def456hij789klm"
    "soa_email_address"       = "jsmith@example.com"
    "passbolt_user_firstname" = "John"
    "passbolt_user_lastname"  = "Smith"
    "passbolt_user_email"     = "admin@example.com"
    "user_name"               = "jsmith"
  }
}

2. Access the Passbolt app

To start registration:

  1. Log in to the instance and follow the link provided in /etc/motd to visit the DNS you chose during deployment.

    cat /etc/motd
    *********************************************************
    Akamai Cloud passbolt Quick Deploy App
    
    Registering admin user: https://$DNS_NAME/setup/start/$UUID
    
    App URL: https://$DNS_NAME
    Credentials File: /home/$SUDO_USER/.credentials
    Documentation: https://techdocs.akamai.com/quick-deploy-apps/docs/passbolt-community-edition
    *********************************************************
    To delete this message of the day: rm /etc/motd

    Download the passbolt-recovery-kit.txt file and store it securely. The PGP private key block and passphrase are required for account recovery.

  2. Open the app registration URL in your browser and create your Passbolt passphrase.

  3. Once the passphrase is set, you are redirected to the Passbolt main page.

Configure email

Postfix is installed during deployment. To send a test email through Passbolt’s SMTP settings (https://[your-domain]/app/administration/smtp-settings), use the following unless you've manually configured an external SMTP provider:

  • Email provider: Other
  • Authentication method: None
  • SMTP host: localhost
  • Use TLS?: No
  • Port: 25
  • SMTP client: leave blank
  • Sender name: root
  • Sender email: root@<example.com>

Note:

To make the most out of Passbolt, you need a working email setup for email notifications, including account registration, password recovery, and other critical notifications. For more information on setting this up, see the Configure Email Providers page on Passbolt’s website.

Regardless of how you configure your mail server, follow the best practices to ensure mail deliverability. For more information, see our Running a Mail Server guide.

Additional resources

For more information about the installed packages, see their official documentation.

📘

Note that we can't vouch for the accuracy or timeliness of externally hosted resources.


Did this page help you?