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.

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.

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.

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 Billing → Subscription 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 Billing → Subscription page.

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

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 Billing → Subscription 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 Billing → 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 once you've completed 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.