Bitwarden automatic backup container

GitHub

Container

Tags

Tag	Architecture	Description
latest	amd64, arm64	Bitwarden CLI Node version

Registries

Registry	Full image name	Description
docker.io	docker.io/zicstardust/bitwarden-backup	Docker Hub
ghcr.io	ghcr.io/zicstardust/bitwarden-backup	GitHub

Usage

Compose

services:
  bitwarden-backup:
    container_name: bitwarden-backup
    image: docker.io/zicstardust/bitwarden-backup:latest
    environment:
      TZ: America/New_York
      PUID: 1000
      PGID: 1000
      INTERVAL: 1d
      BW_CLIENTID: ${BW_CLIENTID}
      BW_CLIENTSECRET: ${BW_CLIENTSECRET}
      BW_PASSWORD: ${BW_PASSWORD}
      ENCRYPTION_KEY: ${ENCRYPTION_KEY}
    volumes:
      - <path to data>:/data/

Environment variables

variables	Function	Default
TZ	Set Timezone
PUID	Set User ID	1000
PGID	Set Group ID	1000
INTERVAL	interval between executions examples: 1d - 1 day 10m - 10 minutes 1w - 1 week 65s - 65 seconds	1d
BW_CLIENTID	Set User Client ID
BW_CLIENTSECRET	Set User Client Secret
BW_PASSWORD	Set User Master Password
ENCRYPTION_KEY	Set password for file encryption
ORGANIZATION_IDS	Backup organization vault array separated by ,
BACKUP_ORGANIZATION_ONLY	Set 1 to skip individual vault backup
KEEP_LAST	Number of backups to keep If value is 0, keep all	0
BACKUP_FORMAT	export backup format options: encrypted_json, json, csv IMPORTANT: Only encrypted_json is encrypted and requires ENCRYPTION_KEY	encrypted_json

For Self-hosted only

variables	Function	Required
BW_SERVER_BASE	On-premises hosted installation URL	Required
BW_SERVER_WEB_VAULT	Custom web vault URL that differs from the BW_SERVER_BASE	Optional
BW_SERVER_API	Custom API URL that differs from the BW_SERVER_BASE	Optional
BW_SERVER_IDENTITY	Custom identity URL that differs from the BW_SERVER_BASE	Optional
BW_SERVER_ICONS	Custom icons service URL that differs from the BW_SERVER_BASE	Optional
BW_SERVER_NOTIFICATIONS	Custom notifications URL that differs from the BW_SERVER_BASE	Optional
BW_SERVER_EVENTS	Custom events URL that differs from the BW_SERVER_BASE	Optional
BW_SERVER_KEY_CONNECTOR	URL for your Key Connector server	Optional