# Vaultwarden

[Vaultwarden](https://github.com/dani-garcia/vaultwarden/) is an unofficial Bitwarden compatible server written in Rust.

## Installation

Enable Vaultwarden by setting `COMPOSE_PROFILES=vaultwarden`. It will be accessible at `/vaultwarden`.

Copy the example environment file and edit as needed before running vaultwarden: `cp vaultwarden/env.example vaultwarden/.env`.

## Backup

Vaultwarden's database and media files can be backed up in the cloud storage product of your choice with [Rclone](https://rclone.org/).

Before a backup can be made, `rclone config` must be run to generate the configuration file:

```shell
docker compose run --rm -it vaultwarden-backup rclone config
```

It will generate a `rclone.conf` configuration file in ./vaultwarden/rclone/rclone.conf.

Copy the backup environment file to `backup.env` and fill it as needed:
`cp backup.env.exmple backup.env`

| Variable             | Description                                                         | Default                   |
| -------------------- | ------------------------------------------------------------------- | ------------------------- |
| `RCLONE_REMOTE_NAME` | Name of the remote you chose during rclone config                   |                           |
| `RCLONE_REMOTE_DIR`  | Name of the rclone remote dir, eg: S3 bucket name, folder name, etc |                           |
| `CRON`               | How often to run the backup                                         | `@daily` backup every day |
| `TIMEZONE`           | Timezone, used for cron times                                       | `America/New_York`        |
| `ZIP_PASSWORD`       | Password to protect the backup archive with                         | `123456`                  |
| `BACKUP_KEEP_DAYS`   | How long to keep the backup in the destination                      | `31` days                 |

You can test your backup manually with:

```shell
docker compose run --rm -it vaultwarden-backup backup
```