https://github.com/zicstardust/bitwarden-backup
Bitwarden automatic backup container
https://github.com/zicstardust/bitwarden-backup
backup bitwarden bitwarden-cli container docker podman
Last synced: 2 months ago
JSON representation
Bitwarden automatic backup container
- Host: GitHub
- URL: https://github.com/zicstardust/bitwarden-backup
- Owner: zicstardust
- Created: 2025-01-04T22:18:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-08T20:11:29.000Z (3 months ago)
- Last Synced: 2026-03-09T00:29:26.871Z (3 months ago)
- Topics: backup, bitwarden, bitwarden-cli, container, docker, podman
- Language: Shell
- Homepage: https://hub.docker.com/r/zicstardust/bitwarden-backup
- Size: 141 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bitwarden automatic backup container
[GitHub](https://github.com/zicstardust/bitwarden-backup)
## Container
### Tags
| Tag | Architecture | Description |
| :----: | :----: | :----: |
| [`latest`](https://github.com/zicstardust/bitwarden-backup/blob/main/dockerfile) | amd64, arm64 | Bitwarden CLI Node version |
### Registries
| Registry | Full image name | Description |
| :----: | :----: | :----: |
| [`docker.io`](https://hub.docker.com/r/zicstardust/bitwarden-backup) | `docker.io/zicstardust/bitwarden-backup` | Docker Hub |
| [`ghcr.io`](https://github.com/zicstardust/bitwarden-backup/pkgs/container/bitwarden-backup) | `ghcr.io/zicstardust/bitwarden-backup` | GitHub |
## Usage
### Compose
```yml
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:
- :/data/
```
## Environment variables
| variables | Function | Default | Exemple/Info |
| :----: | --- | --- | --- |
| `TZ` | Set Timezone | | |
| `PUID` | Set User ID | 1000 | |
| `PGID` | Set Group ID | 1000 | |
| `INTERVAL` | interval between executions< | 1d | `1d - 1 day`
`10m - 10 minutes`
`1w - 1 week`
`65s - 65 seconds` |
| `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 `true` to skip individual vault backup | | |
| `KEEP_LAST` | Number of backups to keep
If value is `0`, keep all | 0 | |
| `BACKUP_FORMAT` | Backup format | encrypted_json | Value: `encrypted_json`, `json`, `csv`, `zip`,
NOTE: Only `encrypted_json` is encrypted and requires `ENCRYPTION_KEY`
NOTE: `zip` includes your attachments
NOTE: `zip` not supported for organization |
### 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 |