Self-hosting Families Sponsorships

If you are self-hosting a Bitwarden enterprise organization, you will need to complete a short setup procedure to allow your users to redeem Families organization sponsorships.

Step 1: Enable cloud communication

To allow your self-hosted enterprise organization to issue sponsorships for cloud Families organizations, your server needs to communicate to our cloud systems which users are eligible for sponsorship.

Hinweis

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

Once you have set this value, apply your change by running the ./bitwarden.sh rebuild command.

Tipp

Self-hosting families sponsorships requires communication with Bitwarden 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: Update your license

Before proceeding, update your self-hosted organization license:

  1. Log in to the cloud web vault (https://vault.bitwarden.com) and navigate to your organization's SettingsSubscription page.

  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.

  4. Log in to your self-hosted web vault (for example, https://company.bitwarden.com) and navigate to your organization's Settings Subscription page.

  5. Select the Update License button and upload the updated license.

Step 3: Setup billing sync

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:

  1. Log in to the cloud web vault (https://vault.bitwarden.com) and navigate to your organization's SettingsSubscription page.

  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 Billing Sync Token.

  5. Log in to your self-hosted web vault (for example, https://company.bitwarden.com) and navigate to your organization's Settings Subscription page.

  6. Select the Manage Billing Sync button.

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

    Hinweis

    The Last Sync in this section will report Never until the first sync, which will occur once daily after you've completed Step 3: Trigger a billing sync.

Step 4: Trigger a billing sync

Once a user has requested sponsorship, they will be allowed to use their sponsorship once a billing sync has occurred. Billing sync will occur once daily, however you can manually trigger a sync at any time. We encourage you to trigger a billing sync after setting up billing sync:

  1. Open your System Administrator Portal.

  2. Select the Organizations tab and open your enterprise organization.

  3. Scroll down to the connections table and select the Manually Sync button in the billing sync entry.

Hinweis

In between syncs, users may see the status Awaiting Sync after redeeming or changing a sponsorship. This indicates your self-hosted Bitwarden server is waiting to sync with the Bitwarden cloud before a sponsorship can be fully redeemed or changed.


Sprache
© 2022 Bitwarden, Inc.
NutzungsbedingungenDatenschutzerklärungSitemap