Self-host an Organization
Step 1: Install and deploy your server
Before you can self-host an organization, you'll need to install and deploy Bitwarden to your server. Bitwarden can be run, using Docker, on Linux and Windows machines. While there are a variety of methods for installing Bitwarden, including methods for offline or air-gapped environments, we recommend starting with one of these guides:
Step 2: Configure organization environment variables
Some features used by Bitwarden organizations are not configured by the standard installation procedure documented in the above articles. To equip your self-hosted server with all the features available to Bitwarden organizations, set the following variables in your ./bwdata/env/global.override.env file:
Variable | Description | Use |
|---|---|---|
globalSettings__mail__smtp__host= | Your SMTP server hostname (recommended) or IP adress. | Used for |
globalSettings__mail__smtp__port= | The SMTP port used by the SMTP server. | Used for |
globalSettings__mail__smtp__ssl= | (Boolean) Whether your SMTP server uses an encryption protocol:
| Used for |
globalSettings__mail__smtp__username= | A valid username for the | Used for |
globalSettings__mail__smtp__passsword= | A valid password for the | Used for |
globalSettings__enableCloudCommunication= | Set to | Used for |
globalSettings__duo__aKey= | A randomly generated Duo akey. For more information, see | Used for |
globalSettings__hibpApiKey= | Your HaveIBeenPwned (HIBP) API Key, available | Allows users to run the |
globalSettings__disableUserRegistration= | Specify | Used to limit users on the server to those invited to the organization. |
globalSettings__sso__enforceSsoPolicyForAllUsers= | Specify | Used to enforce the |
Once you've made changes to your environment variables, perform a ./bitwarden.sh restart to apply the changes to your server.
Step 3: Start your organization
Start a cloud organization
At this stage, you're ready to start your organization and port it over to your self-hosted server. For billing purposes, organizations must first be created in the Bitwarden cloud web vault (
Start a self-hosted organization
Once your cloud organization is created, follow
Self-hosted Bitwarden organizations will be able to utilize all paid features provided by their chosen plan. Only Families and Enterprise organizations can be imported to self-hosted servers. Learn more
Step 4: Setup billing and license sync
Next, setup your self-hosted organization for billing and license sync from your cloud organization. Doing so is optional, but will have a few advantages:
Enabling easier license updating when you change your organization's seat count.
Enabling easier license updating when your subscription comes to its renewal date.
Unlocking
sponsored Families organizationsfor members of Enterprise organizations.
Follow
note
Billing and license syncing requires that the globalSettings__enableCloudCommunication= environment variable is set to true (
Step 5: Start organization administration
You're now ready to start administering your self-hosted organization! Here's how you might approach it:
Invite your admin team
Every all-star organization needs an all-star admin team. Start inviting high-privileged members who can help you build a foundation for secure credential sharing with Bitwarden. If you’re building an Enterprise organization, you can give members
For protective redundancy, we recommend including at least one other organization owner in
Set policies (Enterprise-only)
Your business has unique security needs. Use policies to build a consistent deployment and experience for all team members, like requiring SSO authentication or enrolling members in admin password reset. To get your organization ready for more team members, it's important to
Import your data
Is your business coming to Bitwarden from another password manager? Good news! You can import that data directly to your organization to
Build groups & collections
Once you've got items in your vault, it's a good time to set up collections and groups to ensure that the right users have access to the right credentials. Every organization is different, but here are some tips to help you
Invite your team
It's finally time to start inviting users! If you use an identity provider or directory service like Azure Active Directory, use