Install and Deploy - Offline (Linux)
This article will walk you through the procedure to install and deploy Bitwarden to your own server in an offline or air-gapped environment.
Manual installations should be conducted by advanced users only. Only proceed if you are very familiar with Docker technologies and desire more control over your Bitwarden installation.
Manual installations lack the ability to automatically update certain dependencies of the Bitwarden installation. As you upgrade from one version of Bitwarden to the next you will be responsible for changes to required environment variables, changes to nginx
default.conf, changes to
docker-compose.yml, and so on.
We will try to highlight these in the release notes on GitHub. You can also monitor changes to the dependency templates used by the Bitwarden installation script on GitHub.
Before proceeding with the installation, please ensure the following requirements are met:
Docker Engine and Docker Compose are installed and ready to use on your server.
Using a machine with internet access, you have downloaded the latest
docker-stub.zipfile from the Bitwarden Server repository's releases page and transferred this file to your server.
An offline SMTP Server is setup and active in your environment.
Bitwarden is currently supported only in a Docker and Docker Compose environment. Bitwarden's installation scrips and manual installation artifacts do not accurately convert to Kubernetes manifests without extensive knowledge of the Bitwarden stack and Kubernetes. Automatic conversions of the installation artifacts are not recommended at this time and could result in a broken deployment environment.
x64, 2GHz dual core
Engine 19+ and Compose 1.24+
Engine 19+ and Compose 1.24+
By default, Bitwarden will be served through ports 80 (
http) and 443 (
https) on the host machine. Open these ports so that Bitwarden can be accessed from within and/or outside of the network. You may opt to choose different ports during installation.
We recommend configuring a domain name with DNS records that point to your host machine (for example,
bitwarden.example.com), especially if you are serving Bitwarden over the internet.
We recommend configuring your server with a dedicated bitwarden service account from which to install and run Bitwarden. Doing so will isolate your Bitwarden instance from other applications running on your server.
These steps are Bitwarden-recommended best practices, but are not required. For more information, see Docker's post-installation steps for Linux documentation.
Create a bitwarden user:
sudo adduser bitwardenText Copied!
Set a password for the bitwarden user:
sudo passwd bitwardenText Copied!
Create a docker group (if it doesn't already exist):
sudo groupadd dockerText Copied!
Add the bitwarden user to the docker group:
sudo usermod -aG docker bitwardenText Copied!
Create a bitwarden directory:
sudo mkdir /opt/bitwardenText Copied!
Set permissions for the
sudo chmod -R 700 /opt/bitwardenText Copied!
Set the bitwarden user ownership of the
sudo chown -R bitwarden:bitwarden /opt/bitwardenText Copied!
To configure your machine with the assets required for your Bitwarden server:
If you have created a Bitwarden user & directory, complete the following as the
bitwarden user from the
Create a new directory named
docker-stub.zipto it, for example:
unzip docker-stub.zip -d bwdataText Copied!
Once unzipped, the
bwdatadirectory will match what the
docker-compose.ymlfile's volume mapping expects. You may, if you wish, change the location of these mappings on the host machine.
./bwdata/env/global.override.env, edit the following environment variables:
globalSettings__baseServiceUri__vault=: Enter the domain of your Bitwarden instance.
globalSettings__sqlServer__ConnectionString=: Replace the
RANDOM_DATABASE_PASSWORDwith a secure password for use in a later step.
globalSettings__identityServer__certificatePassword: Set a secure certificate password for use in a later step.
RANDOM_IDENTITY_KEYwith a random key string.
RANDOM_IDENTITY_KEYwith a random key string.
RANDOM_DUO_AKEYwith a random key string.
globalSettings__installation__id=: Enter an installation id retrieved from https://bitwarden.com/host.
globalSettings__installation__key=: Enter an installation key retrieved from https://bitwarden.com/host.
globalSettings__pushRelayBaseUri=: This variable should be blank. See Configure Push Relay for more information.
At this time, consider also setting values for all
globalSettings__mail__smtp__variables and for
adminSettings__admins. Doing so will configure the SMTP mail server used to send invitations to new organization members and provision access to the System Administrator Portal.
./bwdata, generate a
.pfxcertificate file for the identity container and move it to the mapped volume directory (by default,
./bwdata/identity/). For example, run the following commands:
openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout identity.key -out identity.crt -subj "/CN=Bitwarden IdentityServer" -days 10950Text Copied!
openssl pkcs12 -export -out ./identity/identity.pfx -inkey identity.key -in identity.crt -passout pass:IDENTITY_CERT_PASSWORDText Copied!
In the above command, replace
IDENTITY_CERT_PASSWORDwith the certificate password created and used in Step 2.
Create a subdirectory in
./bwdata/sslnamed for your domain, for example:
mkdir ./ssl/bitwarden.example.comText Copied!
Provide a trusted SSL certificate and private key in the newly created
This directory is mapped to the NGINX container at
/etc/ssl. If you can't provide a trusted SSL certificate, front the installation with a proxy that provides an HTTPS endpoint to Bitwarden client applications.
Replace all instances of
bitwarden.example.comwith your domain, including in the
ssl_certificate_keyvariables to the paths of the certificate and private key provided in Step 6.
Take one of the following actions, depending on your certificate setup:
If using a trusted SSL certificate, set the
ssl_trusted_certificatevariable to the path to your certificate.
If using a self-signed certificate, comment out the
RANDOM_DATABASE_PASSWORDwith the password created in Step 2.
bitwarden.example.comwith your domain.
./bwdata/env/uid.env, set the UID and GID of the
bitwardenusers and group you created earlier so the containers run under them, for example:
LOCAL_UID=1001 LOCAL_GID=1001Text Copied!
To get docker images for use on your offline machine:
From an internet-connected machine, download all
bitwarden/xxx:latestdocker images, as listed in the
Save each image to a
.imgfile, for example:
docker image save -o mssql.img bitwarden/mssql:versionText Copied!
.imgfiles to your offline machine.
On your offline machine, load each
.imgfile to create your local docker images, for example:
docker image load -i mssql.imgText Copied!
Start your Bitwarden server with the following command:
docker-compose -f ./docker/docker-compose.yml up -dText Copied!
Verify that all containers are running correctly:
docker psText Copied!
Congratulations! Bitwarden is now up and running at
https://your.domain.com. Visit the web vault in your browser to confirm that it's working.
You may now register a new account and log in. Your will need to have configured SMTP environment variables (see environment variables) in order to verify the email for your new account.
If you are planning to self-host a Bitwarden organization, see self-host an organization to get started.
For additional information see self hosting FAQs.
Updating a self-hosted server that has been installed and deployed manually is different from the standard update procedure. To update your manually-installed server:
Download the latest
docker-stub.ziparchive from the releases pages on GitHub.
Unzip the new
docker-stub.ziparchive and compare its contents with what's currently in your
bwdatadirectory, copying anything new to the pre-existing files in
Do not overwrite your pre-existing
bwdatadirectory with the contents of the newer
docker-stub.ziparchive, as this would overwrite any custom configuration work you've done.
Download the latest container images and transfer them to your offline machine as documented above.
Run the following command to restart your server with your updated configuration and the latest containers:
docker-compose -f ./docker/docker-compose.yml down && docker-compose -f ./docker/docker-compose.yml up -dText Copied!