vwdump/README.md at 8573420236a5f8dd4faa56279349069f829c34bb

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

jmqm 8573420236

- Removed quotation marks with mounting volumes in docker-compose section.
- Replaced INFO prefix with each echo with a timestamp.
  - Subsequently, echoes that have a timestamp at the end have been adjusted to remove them.
- When deleting, it first checks if there are files to delete.
  - An appropriate echo will be shown in both circumstances.

2021-07-17 14:39:17 -05:00

2.9 KiB

Raw Blame History

Backs up vaultwarden files and directories to tar.xz archives automatically. tar.xz archives can be opened using data compression programs like 7-Zip and WinRAR.

Files and directories that are backed up:

db.sqlite3
config.json
rsa_key.der
rsa_key.pem
rsa_key.pub.der
/attachments
/sends

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:latest
    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 at 12:00 AM.
      - UID=1024
      - GID=100

Volumes

/data - Vaultwarden's /data directory. 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. (exclusive to automatic mode)

Optional

Environment Variable	Info
TZ ¹	Timezone inside the container. Can mount `/etc/localtime` instead as well (recommended).
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.9 KiB Raw Blame History