vwdump/README.md at 734956821cf36a91df212cd21735299cd50098d5

mirror of https://github.com/xzeldon/vwdump.git synced 2025-06-28 03:48:13 +03:00

**README.md**
- Minor text change.

**Dockerfile**
- Remove installation of `zip`.
- Add installation if `xz`.

**backup.sh**
- Switch to `tar.xz` archive _(`zip` was messing up permissions)_.
- `echo` when backups start and end.

2021-05-26 00:11:57 -05:00

2.7 KiB

Raw Blame History

Backs up vaultwarden files and folders to tar.xz archives. Can be set to run automatically.

Usage

Automatic Backups

Refer to the docker-compose section below. By default, backing up is automatic.

Manual Backups

Pass manual to docker run or docker-compose as a command.

docker-compose

services:
  vaultwarden:
	# Vaultwarden configuration here.
  backup:
    image: jmqm/vaultwarden_backup
    container_name: vaultwarden_backup
    volumes:
      - "/vaultwarden_data_directory:/data:ro" # Read-only
      - "/backup_directory:/backups"

      - "/etc/localtime:/etc/localtime:ro" # Container uses date from host.
    environment:
      - DELETE_AFTER=30
      - CRON_TIME=* */24 * * * # Runs every 24 hours.
      - UID=1024
      - GID=100

Volumes

/data - Vaultwarden's /data folder. Recommend setting mount as read-only.

/backups - Where to store backups to.

Environment Variables

⭐Required, 👍 Recommended

Environment Variable	Info
UID ⭐	User ID to run the cron job as.
GID ⭐	Group ID to run the cron job as.
CRON_TIME 👍	When to run (default is every 12 hours). Info here and editor here.
DELETE_AFTER 👍	Delete backups X days old. (unsupported at the moment)

Optional

Environment Variable	Info
TZ ¹	Timezone inside the container. Can mount `/etc/localtime` instead as well (recommended).
LOGFILE	Log file path relative to inside the container.
CRONFILE	Cron file path relative to inside the container.

¹ See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for more information

Errors

Unexpected timestamp

Mount etc/localtime (recommend mounting as read-only) or set TZ environment variable.

2.7 KiB Raw Blame History