imcatwhocode / twinspur

🐬 Yet another regular file backup to S3 solution in Docker

Twinspur

Yet another regular file backup to S3 solution in Docker

Features:

• Cron-like schedule or immediate backup at launch
• Symmetric backup encryption using GnuPG

Environment variables configuration

Variable	Required	Default	Description
TAR_OPTS	❌	–	Additional opts for "tar czf" command
S3_ENDPOINT	✅	-	S3 Endpoint
S3_REGION	❌	us-west-1	S3 Region
S3_BUCKET	✅	-	S3 Bucket
S3_PATH	❌	backup	S3 Path relative to a bucket's root
S3_KEY_ID	✅	-	S3 Key ID
S3_ACCESS_KEY	✅	-	S3 Access key
S3_OPTS	❌	-	Additional opts for awscli
WEBHOOK_START	❌	-	We'll make a GET query to this URL before backing up
WEBHOOK_SUCCESS	❌	-	Another GET query will be made to this URL after successful backup
ENCRYPTION_PASSWORD	❌	-	Secret for GPG symmetric encryption
SCHEDULE	❌	**None**	Cron-ish schedule. If empty or **None**, single backup will start immediately

Schedule

Twinspur uses odise/go-cron scheduler built on top of robfig/cron, which supports both "standard" and Quartz formats.

⚠️ However, "standard" format parser seems broken. Please use Quartz instead.

Example

# Example with only required configuration & instant one-time backup
docker run --rm \
  -e S3_ENDPOINT="https://s3.acme.foo.bar" \
  -e S3_BUCKET="pgs3-test" \
  -e S3_KEY_ID="xxxx" \
  -e S3_ACCESS_KEY="xxxx" \
  -v /backup/source/folder:/data:ro \
  imcatwhocode/twinspur

# Example with backup every night at 01:00
# Notice the "/etc/localtime" mount – it's mapping your host timezone to the container
# Without this mount, container will always use the UTC+00:00 TZ
docker run \
  --restart=always \
  -e SCHEDULE="0 0 1 * * *" \
  -v /etc/localtime:/etc/localtime:ro \
  -v /backup/source/folder:/data:ro \
  -e S3_ENDPOINT="https://s3.acme.foo.bar" \
  -e S3_BUCKET="pgs3-test" \
  -e S3_KEY_ID="xxxx" \
  -e S3_ACCESS_KEY="xxxx" \
  -e ENCRYPTION_PASSWORD="test123"\
  -e "WEBHOOK_START=http://172.17.0.1:1337/start" \
  -e "WEBHOOK_SUCCESS=http://172.17.0.1:1337/success" \
  imcatwhocode/twinspur