infrastructure/vwdump
1
0
Fork 0
mirror of https://github.com/xzeldon/vwdump.git synced 2025-07-17 06:46:10 +03:00
Code Issues Activity

Combine scripts, refactor, minor README improvements (#26)

Browse Source 
- Combined backup and delete scripts.
  - Consequently, deleted `backup.sh` and `delete.sh`.
  - Changed Dockerfile and `entrypoint.sh`.
- Refactored script.
- Docker compose example in README now includes network property _(is it called a property?)_.
- README volume permission requirements are placed at better locations.
This commit is contained in:
jmqm
2022-01-02 19:37:08 -06:00
committed by GitHub
parent 23d0115222
commit 479d78b9e3
6 changed files with 61 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -25,6 +25,7 @@ services:
backup:
image: jmqm/vaultwarden_backup:latest
container_name: vaultwarden_backup
network_mode: none
volumes:
- /vaultwarden_data_directory:/data:ro # Read-only
- /backup_directory:/backups
@ -37,10 +38,10 @@ services:
- GID=100
```
## Volumes
`/data` - Vaultwarden's `/data` directory. Recommend setting mount as read-only.
## Volumes _(permissions required)_
`/data` _(read)_- Vaultwarden's `/data` directory. Recommend setting mount as read-only.
`/backups` - Where to store backups to.
`/backups` _(write)_ - Where to store backups to.
## Environment Variables
#### ⭐Required, 👍 Recommended
@ -48,10 +49,8 @@ services:
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| 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](https://www.ibm.com/docs/en/db2oc?topic=task-unix-cron-format) and editor [here](https://crontab.guru/). |
| DELETE_AFTER 👍| Delete backups _X_ days old. _(exclusive to automatic mode)_ |
❗ User must have read permission for `/data` directory and read, write and delete permissions for `/backups`.
| CRON_TIME 👍| When to run _(default is every 12 hours)_. Info [here][cron-format-wiki] and editor [here][cron-editor]. |
| DELETE_AFTER 👍| _(exclusive to automatic mode)_ Delete backups _X_ days old. Requires `read` and `write` permissions. |
#### Optional
| Environment Variable | Info |
@ -62,4 +61,7 @@ services:
## Errors
#### Unexpected timestamp
Mount `etc/localtime` _(recommend mounting as read-only)_ or set `TZ` environment variable.
Mount `/etc/localtime` _(recommend mounting as read-only)_ or set `TZ` environment variable.
[cron-format-wiki]: https://www.ibm.com/docs/en/db2oc?topic=task-unix-cron-format
[cron-editor]: https://crontab.guru/