Compare commits

..

No commits in common. "master" and "v1.1.0" have entirely different histories.

9 changed files with 19 additions and 174 deletions

1
.envrc
View file

@ -1 +0,0 @@
use flake

View file

@ -81,22 +81,12 @@ jobs:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
with: with:
submodules: 'recursive' submodules: 'recursive'
- name: Set up QEMU - name: Build Docker image
uses: docker/setup-qemu-action@v1 run: |
with: docker build . --file Dockerfile --tag ghcr.io/nicolaschan/minecraft-backup:${GITHUB_REF#refs/*/} --tag ghcr.io/nicolaschan/minecraft-backup:latest
platforms: all - name: Publish Docker image
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
with:
version: latest
- name: ghcr.io login
run: | run: |
echo ${{ secrets.CR_PAT }} | docker login ghcr.io -u $GITHUB_ACTOR --password-stdin echo ${{ secrets.CR_PAT }} | docker login ghcr.io -u $GITHUB_ACTOR --password-stdin
- name: Run Buildx docker push ghcr.io/nicolaschan/minecraft-backup:${GITHUB_REF#refs/*/}
run: | docker push ghcr.io/nicolaschan/minecraft-backup:latest
docker buildx build \
--pull \
--push \
--platform linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64 \
--tag ghcr.io/nicolaschan/minecraft-backup:${GITHUB_REF#refs/*/} \
--tag ghcr.io/nicolaschan/minecraft-backup:latest .

1
.gitignore vendored
View file

@ -1,2 +1 @@
coverage coverage
.direnv

View file

@ -1,10 +1,10 @@
FROM alpine FROM alpine
LABEL org.opencontainers.image.source=https://forgejo.nevy.xyz/nev/minecraft-backup LABEL org.opencontainers.image.source=https://github.com/nicolaschan/minecraft-backup
RUN apk add bash coreutils xxd restic util-linux openssh rclone RUN apk add bash coreutils xxd restic util-linux openssh
WORKDIR /code WORKDIR /code
COPY ./backup.sh . COPY ./backup.sh .
ENTRYPOINT ["/bin/sh", "-c"] ENTRYPOINT ["/code/backup.sh"]

View file

@ -44,9 +44,6 @@ docker run \
-v /home/user/server/world:/mnt/server \ -v /home/user/server/world:/mnt/server \
-v /mnt/storage/backups:/mnt/backups \ -v /mnt/storage/backups:/mnt/backups \
ghcr.io/nicolaschan/minecraft-backup -c -i /mnt/server -o /mnt/backups -s server-host:25575:secret -w rcon ghcr.io/nicolaschan/minecraft-backup -c -i /mnt/server -o /mnt/backups -s server-host:25575:secret -w rcon
# Using itzg/docker-minecraft-server container and rcon cli
./backup.sh -c -i /home/user/server/world -o /mnt/storage/backups -s container-name -w docker-rcon
``` ```
This will show chat messages (`-c`) and save a backup of `/home/user/server/world` into `/mnt/storage/backups` using the default thinning deletion policy for old backups. This will show chat messages (`-c`) and save a backup of `/home/user/server/world` into `/mnt/storage/backups` using the default thinning deletion policy for old backups.
@ -59,7 +56,6 @@ Command line options:
-e Compression file extension, exclude leading "." (default: gz) -e Compression file extension, exclude leading "." (default: gz)
-f Output file name (default is the timestamp) -f Output file name (default is the timestamp)
-h Shows this help text -h Shows this help text
-H Set hostname for restic backup (restic only)
-i Input directory (path to world folder, use -i once for each world) -i Input directory (path to world folder, use -i once for each world)
-l Compression level (default: 3) -l Compression level (default: 3)
-m Maximum backups to keep, use -1 for unlimited (default: 128) -m Maximum backups to keep, use -1 for unlimited (default: 128)
@ -67,7 +63,7 @@ Command line options:
-p Prefix that shows in Minecraft chat (default: Backup) -p Prefix that shows in Minecraft chat (default: Backup)
-q Suppress warnings -q Suppress warnings
-r Restic repo name (if using restic) -r Restic repo name (if using restic)
-s Screen name, tmux session name, hostname:port:password for RCON or [container name](https://github.com/itzg/docker-minecraft-server) for docker-rcon -s Screen name, tmux session name, or hostname:port:password for RCON
-t Enable lock file (lock file not used by default) -t Enable lock file (lock file not used by default)
-u Lock file timeout seconds (empty = unlimited) -u Lock file timeout seconds (empty = unlimited)
-v Verbose mode -v Verbose mode

View file

@ -20,7 +20,6 @@ ENABLE_CHAT_MESSAGES=false # Tell players in Minecraft chat about backup status
PREFIX="Backup" # Shows in the chat message PREFIX="Backup" # Shows in the chat message
DEBUG=false # Enable debug messages DEBUG=false # Enable debug messages
SUPPRESS_WARNINGS=false # Suppress warnings SUPPRESS_WARNINGS=false # Suppress warnings
RESTIC_HOSTNAME="" # Leave empty to use system hostname
LOCK_FILE="" # Optional lock file to acquire to ensure two backups don't run at once LOCK_FILE="" # Optional lock file to acquire to ensure two backups don't run at once
LOCK_FILE_TIMEOUT="" # Optional lock file wait timeout (in seconds) LOCK_FILE_TIMEOUT="" # Optional lock file wait timeout (in seconds)
WINDOW_MANAGER="screen" # Choices: screen, tmux, RCON WINDOW_MANAGER="screen" # Choices: screen, tmux, RCON
@ -41,7 +40,7 @@ debug-log () {
fi fi
} }
while getopts 'a:cd:e:f:hH:i:l:m:o:p:qr:s:t:u:vw:x' FLAG; do while getopts 'a:cd:e:f:hi:l:m:o:p:qr:s:t:u:vw:x' FLAG; do
case $FLAG in case $FLAG in
a) COMPRESSION_ALGORITHM=$OPTARG ;; a) COMPRESSION_ALGORITHM=$OPTARG ;;
c) ENABLE_CHAT_MESSAGES=true ;; c) ENABLE_CHAT_MESSAGES=true ;;
@ -56,7 +55,6 @@ while getopts 'a:cd:e:f:hH:i:l:m:o:p:qr:s:t:u:vw:x' FLAG; do
echo "-e Compression file extension, exclude leading \".\" (default: gz)" echo "-e Compression file extension, exclude leading \".\" (default: gz)"
echo "-f Output file name (default is the timestamp)" echo "-f Output file name (default is the timestamp)"
echo "-h Shows this help text" echo "-h Shows this help text"
echo "-H Set hostname for restic backup (restic only)"
echo "-i Input directory (path to world folder, use -i once for each world)" echo "-i Input directory (path to world folder, use -i once for each world)"
echo "-l Compression level (default: 3)" echo "-l Compression level (default: 3)"
echo "-m Maximum backups to keep, use -1 for unlimited (default: 128)" echo "-m Maximum backups to keep, use -1 for unlimited (default: 128)"
@ -69,9 +67,9 @@ while getopts 'a:cd:e:f:hH:i:l:m:o:p:qr:s:t:u:vw:x' FLAG; do
echo "-u Lock file timeout seconds (empty = unlimited)" echo "-u Lock file timeout seconds (empty = unlimited)"
echo "-v Verbose mode" echo "-v Verbose mode"
echo "-w Window manager: screen (default), tmux, RCON" echo "-w Window manager: screen (default), tmux, RCON"
echo "-x Bukkit-style server backup mode (world files are split by dimension)"
exit 0 exit 0
;; ;;
H) RESTIC_HOSTNAME=$OPTARG ;;
i) SERVER_WORLDS+=("$OPTARG") ;; i) SERVER_WORLDS+=("$OPTARG") ;;
l) COMPRESSION_LEVEL=$OPTARG ;; l) COMPRESSION_LEVEL=$OPTARG ;;
m) MAX_BACKUPS=$OPTARG ;; m) MAX_BACKUPS=$OPTARG ;;
@ -266,8 +264,6 @@ execute-command () {
;; ;;
"RCON"|"rcon") rcon-command "$SCREEN_NAME" "$COMMAND" "RCON"|"rcon") rcon-command "$SCREEN_NAME" "$COMMAND"
;; ;;
"docker-rcon") docker exec "$SCREEN_NAME" rcon-cli "$COMMAND"
;;
esac esac
fi fi
} }
@ -526,12 +522,7 @@ do-backup () {
if [[ "$RESTIC_REPO" != "" ]]; then if [[ "$RESTIC_REPO" != "" ]]; then
RESTIC_TIMESTAMP="${TIMESTAMP:0:10} ${TIMESTAMP:11:2}:${TIMESTAMP:14:2}:${TIMESTAMP:17:2}" RESTIC_TIMESTAMP="${TIMESTAMP:0:10} ${TIMESTAMP:11:2}:${TIMESTAMP:14:2}:${TIMESTAMP:17:2}"
if [[ "$RESTIC_HOSTNAME" == "" ]]; then restic backup -r "$RESTIC_REPO" "${SERVER_WORLDS[@]}" --time "$RESTIC_TIMESTAMP" "$QUIET"
RESTIC_HOSTNAME_OPTION=()
else
RESTIC_HOSTNAME_OPTION=("--host" "$RESTIC_HOSTNAME")
fi
restic backup -r "$RESTIC_REPO" "${SERVER_WORLDS[@]}" --time "$RESTIC_TIMESTAMP" "$QUIET" "${RESTIC_HOSTNAME_OPTION[@]}"
ARCHIVE_EXIT_CODE=$? ARCHIVE_EXIT_CODE=$?
if [ "$ARCHIVE_EXIT_CODE" -eq 3 ]; then if [ "$ARCHIVE_EXIT_CODE" -eq 3 ]; then
log-warning "Incomplete snapshot taken (some files could not be read)" log-warning "Incomplete snapshot taken (some files could not be read)"

61
flake.lock generated
View file

@ -1,61 +0,0 @@
{
"nodes": {
"flake-utils": {
"inputs": {
"systems": "systems"
},
"locked": {
"lastModified": 1710146030,
"narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
"type": "github"
},
"original": {
"owner": "numtide",
"repo": "flake-utils",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1725634671,
"narHash": "sha256-v3rIhsJBOMLR8e/RNWxr828tB+WywYIoajrZKFM+0Gg=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "574d1eac1c200690e27b8eb4e24887f8df7ac27c",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixos-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"flake-utils": "flake-utils",
"nixpkgs": "nixpkgs"
}
},
"systems": {
"locked": {
"lastModified": 1681028828,
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
"owner": "nix-systems",
"repo": "default",
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
"type": "github"
},
"original": {
"owner": "nix-systems",
"repo": "default",
"type": "github"
}
}
},
"root": "root",
"version": 7
}

View file

@ -1,36 +0,0 @@
{
description = "A flake for bash, coreutils, xxd, restic, util-linux, and openssh";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
};
outputs = {
self,
nixpkgs,
flake-utils,
}:
flake-utils.lib.eachDefaultSystem (
system: let
pkgs = nixpkgs.legacyPackages.${system};
in {
devShell = pkgs.mkShell {
buildInputs = with pkgs; [
bash
coreutils
kcov
vim # provides xxd
python3
python312Packages.fusepy
restic
screen
shellcheck
tmux
utillinux
openssh
];
};
}
);
}

View file

@ -50,7 +50,7 @@ assert-equals-directory () {
fi fi
if [ -d "$1" ]; then if [ -d "$1" ]; then
for FILE in "$1"/*; do for FILE in "$1"/*; do
assert-equals-directory "$FILE" "$2/${FILE##"$1"}" assert-equals-directory "$FILE" "$2/${FILE##$1}"
done done
else else
assertEquals "$(cat "$1")" "$(cat "$2")" assertEquals "$(cat "$1")" "$(cat "$2")"
@ -80,24 +80,6 @@ check-latest-backup-restic () {
# Tests # Tests
test-restic-explicit-hostname () {
EXPECTED_HOSTNAME="${HOSTNAME}blahblah"
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")"
./backup.sh -i "$TEST_TMP/server/world" -r "$TEST_TMP/backups-restic" -s "$SCREEN_TMP" -f "$TIMESTAMP" -H "$EXPECTED_HOSTNAME"
check-latest-backup-restic
LATEST_BACKUP_HOSTNAME=$(restic -r "$TEST_TMP/backups-restic" snapshots latest --json | jq -r '.[0]["hostname"]')
assertEquals "$EXPECTED_HOSTNAME" "$LATEST_BACKUP_HOSTNAME"
}
test-restic-default-hostname () {
EXPECTED_HOSTNAME="${HOSTNAME}"
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")"
./backup.sh -i "$TEST_TMP/server/world" -r "$TEST_TMP/backups-restic" -s "$SCREEN_TMP" -f "$TIMESTAMP"
check-latest-backup-restic
LATEST_BACKUP_HOSTNAME=$(restic -r "$TEST_TMP/backups-restic" snapshots latest --json | jq -r '.[0]["hostname"]')
assertEquals "$EXPECTED_HOSTNAME" "$LATEST_BACKUP_HOSTNAME"
}
test-backup-defaults () { test-backup-defaults () {
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")" TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")"
./backup.sh -i "$TEST_TMP/server/world" -o "$TEST_TMP/backups" -s "$SCREEN_TMP" -f "$TIMESTAMP" ./backup.sh -i "$TEST_TMP/server/world" -o "$TEST_TMP/backups" -s "$SCREEN_TMP" -f "$TIMESTAMP"
@ -136,6 +118,8 @@ test-file-changed-as-read-warning () {
assert-equals-directory "$WORLD_DIR/file3.txt" "$TEST_TMP/restored/$WORLD_DIR/file3.txt" assert-equals-directory "$WORLD_DIR/file3.txt" "$TEST_TMP/restored/$WORLD_DIR/file3.txt"
} }
test-lock-defaults () { test-lock-defaults () {
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")" TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")"
./backup.sh -t "$TEST_TMP/lockfile" -i "$TEST_TMP/server/world" -o "$TEST_TMP/backups" -s "$SCREEN_TMP" -f "$TIMESTAMP" ./backup.sh -t "$TEST_TMP/lockfile" -i "$TEST_TMP/server/world" -o "$TEST_TMP/backups" -s "$SCREEN_TMP" -f "$TIMESTAMP"
@ -239,6 +223,7 @@ test-restic-defaults () {
check-latest-backup-restic check-latest-backup-restic
} }
test-backup-spaces-in-directory () { test-backup-spaces-in-directory () {
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")" TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")"
WORLD_SPACES="$TEST_TMP/minecraft server/the world" WORLD_SPACES="$TEST_TMP/minecraft server/the world"
@ -379,20 +364,6 @@ test-rcon-interface-not-running () {
assertContains "$OUTPUT" "Could not connect" assertContains "$OUTPUT" "Could not connect"
} }
test-docker-rcon () {
CONTAINER="$(docker run -d -e EULA=TRUE docker.io/itzg/minecraft-server)"
while ! docker exec "$CONTAINER" grep 'RCON running on 0.0.0.0:25575' /data/logs/latest.log; do
sleep 0.1
done
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01")"
./backup.sh -w docker-rcon -i "$TEST_TMP/server/world" -o "$TEST_TMP/backups" -s "$CONTAINER" -f "$TIMESTAMP"
OUTPUT="$(docker exec "$CONTAINER" cat /data/logs/latest.log)"
docker rm -f "$CONTAINER"
assertContains "$OUTPUT" "[Rcon: Automatic saving is now disabled]"
assertContains "$OUTPUT" "[Rcon: Automatic saving is now enabled]"
assertContains "$OUTPUT" "[Rcon: Saved the game]"
}
test-sequential-delete () { test-sequential-delete () {
for i in $(seq 0 20); do for i in $(seq 0 20); do
TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01 +$i hour")" TIMESTAMP="$(date +%F_%H-%M-%S --date="2021-01-01 +$i hour")"
@ -524,14 +495,10 @@ test-restic-thinning-delete () {
done done
UNEXPECTED_TIMESTAMPS=( UNEXPECTED_TIMESTAMPS=(
"2021-01-01 00:00:00" "2021-01-01 00:00:00"
"2021-01-01 01:00:00"
"2021-01-01 02:00:00"
"2021-01-02 22:00:00" "2021-01-02 22:00:00"
"2021-01-03 22:00:00"
"2021-01-04 00:00:00"
) )
for TIMESTAMP in "${UNEXPECTED_TIMESTAMPS[@]}"; do for TIMESTAMP in "${UNEXPECTED_TIMESTAMPS[@]}"; do
assertNotContains "$SNAPSHOTS" "$TIMESTAMP" assertNotContains "$SNAPSHOTS" "$TIMESTAMP"
done done
} }