Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kwheelans/salvage
A docker container utility to schedule archiving container volumes.
https://github.com/kwheelans/salvage
docker docker-volume-backup volume
Last synced: about 2 months ago
JSON representation
A docker container utility to schedule archiving container volumes.
- Host: GitHub
- URL: https://github.com/kwheelans/salvage
- Owner: kwheelans
- License: mit
- Created: 2023-10-23T20:15:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-22T19:23:43.000Z (11 months ago)
- Last Synced: 2024-02-22T20:39:57.689Z (11 months ago)
- Topics: docker, docker-volume-backup, volume
- Language: Rust
- Homepage:
- Size: 139 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Salvage
[](./LICENSE)
[](https://github.com/kwheelans/salvage/releases)
A docker container utility to schedule archiving container volumes.
## Usage
Volumes mounted to a directory under `/data` will be archived to the volume mounted at `/archive` inside the Salvage container.
Directories are added to a tarball based on the archive strategy and are then compressed with the selected archive compression type.
Each archive is timestamped based on when the archive process started running, meaning all archives created during the same job run will have the same timestamp ni their filename.
Timestamps are created in the format `[year]-[month]-[day]_[hour]-[minute]-[second]`.
### Examples
#### Docker
```shell
docker run -d \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /path/to/archive/directory:/archive \
-v my-app-volume:/data/app \
--name salvage \
--restart=always \
kwheelans/salvage:latest
```
#### Docker Compose
```yaml
version: "3.8"
services:
salvage:
container_name: salvage
image: kwheelans/salvage:latest
restart: unless-stopped
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /path/to/archive/directory:/archive
- my-app-volume:/data/app
volumes:
my-app-volume:
external: true
```
## Environment Variables
| Variable | Default | Description |
|-----------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| SCHEDULE | `0 0 * * *` | Standard cron expression.
See https://en.wikipedia.org/wiki/Cron. |
| TZ | `UTC` | Provide TZ identifier to use in the container (ie `America/Phoenix`). See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
| SALVAGE_ARCHIVE_COMPRESSION | `gzip` | Compression used on the tarball archive.
Valid values `bzip2`, `gzip`, `xz`, `zstd`. |
| SALVAGE_ARCHIVE_COMPRESSION_LEVEL | `6` | Set the compression level to be used by the selected archive compression. |
| SALVAGE_ARCHIVE_STRATEGY | `multiple` | `multiple` - Compress each directory into is own archive.
`single` - Compress all directories into one archive. |
| SALVAGE_ARCHIVE_PREFIX | `salvage` | Provide the prefix to be used when creating the backup archives. |
| SALVAGE_ARCHIVE_GROUP_PERMISSION | `read` | Provide how the group permission should be set for the backup archive.
Valid values `read`, `read-write`, `none`. |
| SALVAGE_ARCHIVE_OTHER_PERMISSION | `read` | Provide how the other permission should be set for the backup archive.
Valid values `read`, `read-write`, `none`. |
| SALVAGE_CONTAINER_MANAGEMENT | `true` | Controls if containers should be stopped while their volumes are being backed up. |
| SALVAGE_RUN_ONCE | `false` | When set to true salvage will only run once and exit and not on a schedule. |
## Container Registries
| Container Registry | Image |
|---------------------------|-------------------------------------------------------------------|
| Docker Hub | [kwheelans/salvage](https://hub.docker.com/r/kwheelans/salvage) |
| GitHub Container Registry | [ghcr.io/kwheelans/salvage](https://github.com/kwheelans/salvage) |