Self-hosting

License Paid Features

Self-hosting Bitwarden is free, however some features must be unlocked in your self-hosted instance with a registered license file. A license file can be obtained from the Bitwarden-hosted web vault by either an account with a premium individual subscription or by the owner of an organization.

The steps are different when working with an individual license versus an organization license.

note

The procedures in this article assume that you have already started a paid subscription to Bitwarden. If you haven't, refer to About Bitwarden Plans and What Plan is Right for Me?

Individual license

Follow these procedures when working with an individual license for a premium subscription. You'll be working in both the cloud web vault and your self-hosted web vault, and your account email addresses should match.

Retrieve individual license

After you create an account on your self-hosted server, retrieve your license from the cloud web vault:

  1. Select the profile icon, and choose Account settings from the dropdown:

    Account Settings |
    Account Settings

  2. Select Subscription from the Account Settings menu.

  3. Select the Download license button.

Apply individual license

Next, log in to your self-hosted Bitwarden server to apply the downloaded license:

  1. If you haven't already, verify your email address. You will need to have configured SMTP-related environment variables to do so.

  2. Select the profile icon and choose Account settings from the dropdown.

  3. Select Subscription from the Account Settings menu.

  4. In the License File section, select the Browse... or Choose File button button and add the downloaded license file.

  5. Select the Submit button to apply your premium license.

Update individual license

If for any reason you need to update your individual license file, for example when it expires:

  1. Follow the steps to Retrieve your license again.

  2. Follow the steps to Apply your license again, only this time you will see an Update license button rather than a button to browse for a new license.

Organization license

Follow these procedures when working with an organization license for a Families or Enterprise organization.

note

You must be an organization owner to retrieve, apply, and update a license.

Retrieve organization license

Before starting an organization on your self-hosted server, retrieve your organization license from the cloud web vault:

  1. Open the organization's Billing tab and select Subscription from the left menu.

  2. Select the Download license button.

  3. When prompted, enter the installation ID that was used to install your self-hosted server and select Submit. If you don't know the installation ID off-hand, you can retrieve it from ./bwdata/env/global.override.env.

Apply organization license

Applying your license in a self-hosted server is the means by which you'll create a self-hosted organization. From your self-hosted web vault:

  1. Start a new organization by selecting the Add organization button.

  2. Select the Browse... or Choose File button, add the downloaded license file, and select Submit.

note

If you receive a version not supported error message, update your server and try uploading your license file again. To update your server, make a backup of the bwdata directory and follow these instructions.

Update organization license

Organizations may need to update the license file on their self-hosted server, for example to add user seats or when your license expires. When your license expires and your organization renews, you have 60 days to apply the updated license file to your self-hosted organization.

There are two methods for doing so, however Families organizations may only update manually:

Automatic billing sync unlocks Families sponsorships (only for Enterprise) and simplified license updating, preventing admins from needing to manually re-upload licenses, for example in the case of organization renewal. To set up automatic sync:

Step 1: Enable cloud communication

First, you'll need to configure your server to allow communication with our cloud systems.

note

This step must be completed by someone with access to your self-hosted instance's configuration files.

In order to enable cloud communication, set the following line in bwdata/env/global.override.env to true:

globalSettings__enableCloudCommunication=true
Text Copied!

Once you have set this value, apply your change by running the ./bitwarden.sh rebuild command. Start your server again with the ./bitwarden.sh start command.

note

Enabling automatic sync requires communication with Bitwarden's cloud systems. If your environment uses a firewall to block outbound traffic, you will need to allow https://api.bitwarden.com and https://identity.bitwarden.com.

Step 2: Retrieve billing sync token

Once cloud communication is enabled at the server-level, a sync token needs to be passed from the cloud organization you use for billing to your self-hosted organization. To retrieve your sync token from the cloud web vault:

  1. Open the cloud organization's Billing tab and select Subscription from the left menu.

  2. Scroll down to the self-hosting section and select the Set up billing sync button.

  3. Enter your master password and select Generate token.

  4. Copy the generated token.

Step 3: Apply billing sync token

To apply the billing sync token to your self-hosted organization:

  1. Open the self-hosted organization's Billing tab and select Subscription from the left menu.

  2. In the License and billing management section, choose the Automatic sync option.

  3. Select the Manage billing sync button.

  4. Paste your generated Billing Sync Token and select Save.

note

Sync for Families for Enterprise will occur once daily once you've triggered your first sync. The Last sync field in this section will report Never until you trigger your first sync.

Sync for license updates must always be done manually by selecting the Sync license button (see the next section for details).

Step 4: Trigger sync

Trigger a sync once you've completed setup and each time you need to update your license. Sync for Familes for Enterprise will occur once daily. To trigger a sync:

  1. Open the self-hosted organization's Billing tab and select Subscription from the left menu.

  2. Select the Sync license button.

note

If you receive a version not supported error message, update your server and try uploading your license file again. To update your server, make a backup of the bwdata directory and follow these instructions.

To manually re-upload a license file:

  1. Follow the steps to Retrieve your license again.

  2. Open the self-hosted organization's Billing tab and select Subscription from the left menu.

  3. In the License and billing management section, choose the Manual upload option.

  4. Select the Browse... or Choose File button to add your license file.

  5. Select Submit.

note

If you receive a version not supported error message, update your server and try uploading your license file again. To update your server, make a backup of the bwdata directory and follow these instructions.



© 2023 Bitwarden, Inc.
TermsPrivacySitemap