Unified Deployment beta

note

Bitwarden Unified is not intended for Enterprise users. This solution is in beta and intended for personal use. Business plans should use the officially-supported, standard deployment option.

While the Bitwarden unified self-hosted deployment is in beta, those installing unified should not setup automatic upgrade procedures that pull the latest images available. Bitwarden recommends allowing some time for stabilization of a release before upgrading.

Learn how to report issues.

Den här artikeln kommer att leda dig genom att installera och lansera Bitwarden unified self-hosted distribution. Använd den här distributionsmetoden för att:

Förenkla konfigurationen och optimera resursanvändningen (CPU, minne) genom att distribuera Bitwarden med en enda Docker-bild.
Använd olika databaslösningar som MSSQL, PostgreSQL, SQLite och MySQL/MariaDB.
Kör på ARM-arkitektur för alternativa system som Raspberry Pi och NAS-servrar.

Systemkrav

Bitwarden unified distribution kräver:

Minst 200 MB RAM
Lagring 1GB
Docker Engine 26+

Installera Docker

Den enhetliga distributionen kommer att köras på din dator med en Docker-behållare. Den enhetliga distributionen kan köras med vilken Docker-utgåva eller plan som helst. Utvärdera vilken utgåva som är bäst för din installation.

Installera Docker på din maskin innan du fortsätter med installationen. Se följande Docker-dokumentation för hjälp:

Installera Docker Engine

Kör Bitwarden unified

Den enhetliga distributionen kan köras med kommandot docker run (se här) eller med Docker Compose (se här). I båda fallen måste du ange miljövariabler för behållaren.

Snabbstartguide

Använd docker run för att starta Bitwarden på en Raspberry Pi:



Ange miljövariabler

Att köra den förenade distributionen kräver att miljövariabler ställs in för behållaren. Miljövariabler kan specificeras genom att skapa en settings.env-fil, som du kan hitta ett exempel på i vårt GitHub-förråd, eller genom att använda flaggan --env om du använder docker run-metoden. Flera valfria variabler är tillgängliga för användning för en mer personlig enhetlig implementeringsupplevelse. Ytterligare information om dessa variabler finns här.

Ange åtminstone värden för variablerna som faller under avsnittet # Required Settings # i exemplet .env-fil:

Variabel	Beskrivning
BW_DOMAIN	Ersätt `bitwarden.yourdomain.com` med domänen där Bitwarden kommer att nås.
BW_DB_PROVIDER	Databasleverantören du kommer att använda för din Bitwarden-server. Tillgängliga alternativ är `sqlserver`, `postgresql`, `sqlite` eller `mysql`/`mariadb`.
BW_DB_SERVER	Namnet på servern som din databas körs på.
BW_DB_DATABASE	Namnet på din Bitwarden-databas.
BW_DB_USERNAME	Användarnamnet för åtkomst till Bitwarden-databasen.
BW_DB_PASSWORD	Lösenordet för åtkomst till Bitwarden-databasen.
BW_DB_FILE	Krävs bara för `sqlite` om du vill ange sökvägen till din databasfil. Om det inte anges kommer `sqlite` automatiskt att skapa en `vault.db-fil` under volymen /`etc/bitwarden`.
BW_INSTALLATION_ID	Ett giltigt installations-ID genererat från https://bitwarden.com/host/.
BW_INSTALLATION_KEY	En giltig installationsnyckel genererad från https://bitwarden.com/host/.

note

Unlike the Bitwarden standard deployment, unified deployment does not come out-of-the-box with a database. You can use an existing database, or create a new one as documented in this example, and in both cases you must enter valid information in the BW_DB_... variables documented here.

Using non-MSSQL database providers may result in performance issues, as support for these platforms continues to be worked on throughout the beta. Please use this issue template to report anything related to your Bitwarden unified deployment and check out this page to track known issues or join the discussion.

Använder docker run

Den enhetliga distributionen kan köras med kommandot docker run, som i följande exempel:

Bash
docker run -d --name bitwarden -v /$(pwd)/bwdata/:/etc/bitwarden -p 80:8080  --env-file settings.env ghcr.io/bitwarden/self-host:beta

Kommandot ovan har flera nödvändiga alternativ för kommandot docker run, inklusive:

Namn, stenografi	Beskrivning
--frigör , -d	Kör behållaren i bakgrunden och skriv ut behållar-ID.
--namn	Ange ett namn för behållaren. `bitwarden` används i exemplet.
--volym , -v	Bind montera en volym. Montera åtminstone /`etc/bitwarden`.
--publicera , -s	Kartlägg containerportar till värden. Exemplet visar porten `80:8080` mappad. Port 8443 krävs vid konfigurering av SSL.
--env-fil	Sökväg till filen att läsa miljövariabler från. Alternativt kan du använda `flaggan` --env för att deklarera miljövariabler inline (läs mer).

När du har kört kommandot, verifiera att behållaren är igång och frisk med:

Bash
docker ps

Grattis! Din enhetliga implementering är nu igång på https://din.domän.com. Besök webbvalvet i din webbläsare för att bekräfta att det fungerar. Du kan nu registrera ett nytt konto och logga in.

Använda Docker Compose

Att köra den enhetliga distributionen med Docker Compose kräver Docker Compose version 1.24+. För att köra den enhetliga distributionen med Docker compose, skapa en docker-compose.yml-fil, till exempel:

Bash
---
version: "3.8"

services:
  bitwarden:
    depends_on:
      - db
    env_file:
      - settings.env
    image: ghcr.io/bitwarden/self-host:beta
    restart: always
    ports:
      - "80:8080"
    volumes:
      - bitwarden:/etc/bitwarden

  db:
    environment:
      MARIADB_USER: "bitwarden"
      MARIADB_PASSWORD: "super_strong_password"
      MARIADB_DATABASE: "bitwarden_vault"
      MARIADB_RANDOM_ROOT_PASSWORD: "true"
    image: mariadb:10
    restart: always
    volumes:
      - data:/var/lib/mysql

volumes:
  bitwarden:
  data:

I filen docker-compose.yml gör du önskade konfigurationer inklusive:

Mappning av volymer för loggar och Bitwarden-data.
Kartläggning av portar.
Konfigurera en databasavbildning.ª

ªStäll bara in en databas i docker-compose.yml, som i exemplet ovan, om du vill skapa en ny databasserver att använda med Bitwarden. Exempelkonfigurationer för MySQL, MSSQL och PostgreSQL ingår i vår exempelfil.

När filen docker-compose.yml och settings.env har skapats startar du din enhetliga server genom att köra:

Bash
docker compose up -d

Kontrollera att alla behållare körs korrekt:

Bash
docker ps

Uppdatera din server

Så här uppdaterar du din enhetliga implementering:

Stop the running Docker container:
```
Bash
docker stop bitwarden
```
Remove the Docker container:
```
Bash
docker rm bitwarden
```
Run the following command to pull the most recent Bitwarden unified image:
```
Bash
docker pull ghcr.io/bitwarden/self-host:beta
```

Run the Docker container again:

Bash
docker run -d --name bitwarden -v /$(pwd)/bwdata/:/etc/bitwarden -p 80:8080 --env-file settings.env ghcr.io/bitwarden/self-host:beta

Stop the running Docker container:
```
Bash
docker compose down
```
Run the following command to pull the most recent Bitwarden unified image:
```
Bash
docker compose pull
```
Recreate any containers that need to be updated:
```
Bash
docker compose up -d
```
Verify that the containers are running:
```
Bash
docker compose ps
```

Miljövariabler

Den enhetliga distributionen kommer att fungera som standard utan flera av de vanliga Bitwarden-tjänsterna. Detta möjliggör ökad anpassning och optimering av din enhetliga implementering. Konfigurera dessa tjänster och fler valfria inställningar genom att redigera olika miljövariabler.

note

Whenever you change an environment variable, the Docker container will need to be recreated. Learn more here.

Webserverportar

Variabel	Beskrivning
BW_PORT_HTTP	Ändra porten som används för HTTP-trafik. Som standard, `8080`.
BW_PORT_HTTPS	Ändra porten som används för HTTPS-trafik. Som standard, `8443`.

SSL

Använd dessa värden för att ändra certifikatinställningar.

Variabel	Beskrivning
BW_ENABLE_SSL	Använd SSL/TLS. `sant`/`falskt`. Default `false`. SSL krävs för att Bitwarden ska fungera korrekt. Om du inte använder SSL konfigurerat i Bitwarden-behållaren bör du fronta Bitwarden med en SSL-proxy.
BW_SSL_CERT	Namnet på din SSL-certifikatfil. Filen måste finnas i `katalogen` /etc/bitwarden i behållaren. Standard `ssl.crt`.
BW_SSL_KEY	Namnet på din SSL-nyckelfil. Filen måste finnas i `katalogen` /etc/bitwarden i behållaren. Standard `ssl.key`.
BW_ENABLE_SSL_CA	Använd SSL med certifikatutfärdare (CA)-stödd tjänst. `sant`/`falskt`. Default `false`.
BW_SSL_CA_CERT	Namnet på ditt SSL CA-certifikat. Filen måste finnas i `katalogen` /etc/bitwarden i behållaren. Standard `ca.crt`.
BW_ENABLE_SSL_DH	Använd SSL med Diffie-Hellman nyckelutbyte. `sant`/`falskt`. Default `false`.
BW_SSL_DH_CERT	Namnet på din Diffie-Hellman parameterfil. Filen måste finnas i `katalogen` /etc/bitwarden i behållaren. Standard `dh.pem`.
BW_SSL_PROTOCOLS	SSL-version som används av NGINX. Lämna tomt för rekommenderad standard. Läs mer.
BW_SSL_CIPHERS	SSL-chiffersviter som används av NGINX. Lämna tomt för rekommenderad standard. Läs mer.

note

If you are using an existing SSL certificate, you will have to enable the appropriate SSL options in settings.env. SSL files must be stored in /etc/bitwarden, which can be referenced in the the docker-compose.yml file. These files must match the names configured in settings.env.

The default behavior is to generate a self-signed certificate if SSL is enabled and no existing certificate files are in the expected location (/etc/bitwarden).

Tjänster

Ytterligare tjänster kan aktiveras eller inaktiveras för specifika användningsfall, som företags- eller teambehov, genom att ändra följande värden:

Variabel	Beskrivning
BW_ENABLE_ADMIN	Inaktivera inte den här tjänsten. Läs mer om administratörspanelens funktioner här. Standard `sant`.
BW_ENABLE_API	Inaktivera inte den här tjänsten. Standard `sant`.
BW_ENABLE_EVENTS	Aktivera eller inaktivera Bitwarden-händelseloggar för team och företagshändelseövervakning. Default `false`.
BW_ENABLE_ICONS	Aktivera eller inaktivera Bitwarden varumärkesikoner som är inställda med inloggningsobjektets URI:s. Läs mer här. Standard `sant`.
BW_ENABLE_IDENTITY	Inaktivera inte den här tjänsten. Standard `sant`.
BW_ENABLE_NOTIFICATIONS	Aktivera eller inaktivera aviseringstjänster för att ta emot push-meddelanden till mobila enheter, använda inloggning med enhet, synkronisering av mobilvalv och mer. Standard `sant`.
BW_ENABLE_SCIM	Aktivera eller inaktivera SCIM för företagsorganisationer. Default `false`.
BW_ENABLE_SSO	Aktivera eller inaktivera SSO-tjänster för företagsorganisationer. Default `false`.
BW_ICONS_PROXY_TO_CLOUD	Om du aktiverar den här tjänsten kommer proxyikontjänstbegäranden att fungera via molntjänster för att minska systemminnesbelastningen. Om du väljer att använda den här inställningen `ska` BW_ENABLE_ICONS ställas in på `false` för att minska containerbelastningen. Default `false`.

Post

Konfigurera SMTP-inställningar för din enhetliga distribution. Kopiera information från din valda SMTP-postleverantör till följande fält:

Variabel	Beskrivning
globalSettings__mail__replyToEmail	Ange svarsmail för din server.
globalSettings__mail__smtp__host	Ange värddomän för din SMTP-server.
globalSettings__mail__smtp__port	Ange portnumret från SMTP-värden.
globalSettings__mail__smtp__ssl	Om din SMTP-värd använder SSL anger du true. Ställ in värdet på `false om` din värd använder TLS-tjänsten.
globalSettings__mail__smtp__användarnamn	Ange SMTP-användarnamnet.
globalSettings__mail__smtp__lösenord	Ange SMTP-lösenordet.

Yubico API (YubiKey)

Variabel	Beskrivning
globalSettings__yubico__clientId	Ersätt värdet med ID mottaget från din Yubico Key. Registrera dig för Yubico Key här.
globalSettings__yubico__key	Mata in nyckelvärdet mottaget från Yubico.

Variabel

Beskrivning

globalSettings__yubico__clientId

Ersätt värdet med ID mottaget från din Yubico Key.

Registrera dig för Yubico Key här.

globalSettings__yubico__key

Mata in nyckelvärdet mottaget från Yubico.

Databaskonfigurationer

Att använda de olika databasalternativen som är kompatibla med den enhetliga distributionen kommer att kräva ytterligare .env-konfigurationer.

In settings.env:

Bash
# Database
BW_DB_PROVIDER=mysql
BW_DB_SERVER=db
BW_DB_DATABASE=bitwarden_vault
BW_DB_USERNAME=bitwarden
BW_DB_PASSWORD=super_strong_password

In settings.env:

Bash
# Database
BW_DB_PROVIDER=sqlserver
BW_DB_SERVER=db
BW_DB_DATABASE=bitwarden_vault
BW_DB_USERNAME=bitwarden
BW_DB_PASSWORD=super_strong_password

In settings.env:

Bash
# Database
BW_DB_PROVIDER=sqlite
BW_DB_FILE=/path/to/.db

Assigning the sqlite value will create a vault.db file in the /etc/bitwarden volume automatically. BW_DB_FILE is only required if you would like to specify the path to a different database file.

In settings.env:

Bash
# Database
BW_DB_PROVIDER=postgresql
BW_DB_SERVER=db
BW_DB_DATABASE=bitwarden_vault
BW_DB_USERNAME=bitwarden
BW_DB_PASSWORD=super_strong_password

Andra

Variabel	Beskrivning
globalSettings__disableUserRegistration	Aktivera eller inaktivera registreringsfunktioner för användarkonton.
globalSettings__hibpApiKey	Ange API-nyckeln från Have I Been Pwnd. Registrera dig för att få API-nyckeln här.
adminSettings__admins	Ange administratörens e-postadresser.
BW_REAL_IPS	Definiera riktiga IP-adresser i `nginx.conf` i en kommaseparerad lista. Användbar för att definiera proxyservrar som vidarebefordrar klientens IP-adress. Läs mer.
BW_CSP	Content-Security-Policy parameter. Om du konfigurerar om den här parametern kan funktionerna gå sönder. Genom att ändra denna parameter blir du ansvarig för att bibehålla detta värde.
BW_DB_PORT	Ange en anpassad port för databastrafik. Om det är ospecificerat kommer standardvärdet att bero på din valda databasleverantör.

Starta om behållaren

För att starta om din Docker-behållare efter att ha ändrat miljövariabler, kör följande kommandon från Bitwardens unified distributionskatalog:

Stop the running Docker container:
```
Bash
docker stop bitwarden
```
Remove the Docker container:
```
Bash
docker rm bitwarden
```

Run the Docker container again:

Bash
docker run -d --name bitwarden -v /$(pwd)/bwdata/:/etc/bitwarden -p 80:8080  --env-file settings.env ghcr.io/bitwarden/self-host:beta

Stop the running Docker container:
```
Bash
docker compose down
```
Recreate the containers:
```
Bash
docker compose up -d
```
Ensure that the containers are running properly with:
```
Bash
docker compose ps
```

Minnesanvändning

Som standard kommer Bitwarden-behållaren att förbruka minne som är tillgängligt för den, ofta mer än det minimum som krävs för att köras. För minnesmedvetna miljöer kan du använda docker -m eller --memory= för att begränsa Bitwarden-behållarens minnesanvändning.

Namn, stenografi	Beskrivning
--minne=, -m	Den maximala mängden minne som behållaren kan använda. Bitwarden kräver minst 200m. Se Docker-dokumentationen för mer information.

För att kontrollera minnesanvändningen med Docker Compose, använd mem_limit-nyckeln:

Bash
services:
  bitwarden:
    env_file:
      - settings.env
    image: ghcr.io/bitwarden/self-host:beta
    restart: always
    mem_limit: 200m

Rapporteringsproblem

Medan den förenade Bitwarden-implementeringen förblir i betaversion, uppmuntrar vi dig att rapportera problem och ge feedback via GitHub. Använd den här problemmallen för att rapportera allt som har med din enhetliga Bitwarden-installation att göra och kolla in den här sidan för att spåra kända problem eller gå med i diskussionen.

Ytterligare resurser

Om du planerar att själv vara värd för en Bitwarden-organisation, se självvärd för en organisation för att komma igång.

För mer information om Bitwardens standard self-hosted distribution se:

Suggest changes to this page

How can we improve this page for you?
For technical, billing, and product questions, please contact support



Unified Deployment beta

note

Systemkrav

Installera Docker

Kör Bitwarden unified

Snabbstartguide

Ange miljövariabler

note

Använder docker run

Använda Docker Compose

Uppdatera din server

Miljövariabler

note

Webserverportar

SSL

note

Tjänster

Post

Yubico API (YubiKey)

Databaskonfigurationer

Andra

Starta om behållaren

Minnesanvändning

Rapporteringsproblem

Ytterligare resurser

Suggest changes to this page

Cloud Status