4 Commits

Author SHA1 Message Date
733f5e2504 added the official docker cli
All checks were successful
Build and Push Docker Image / build (push) Successful in 39s
-switched to user 1000 for security.
-added user to docker group
-properly mounted btrfs drive on host allows users to create snapshots
2025-10-22 16:44:48 -07:00
2e2211b26e added timezone dropdown selector 2025-10-22 10:42:18 -07:00
ece058e9da debugging 2025-10-22 10:17:06 -07:00
6e157cf8ee added gitignore and added .env as an ignored type 2025-10-22 10:11:21 -07:00
8 changed files with 170 additions and 68 deletions

1
.gitignore vendored
View File

@@ -0,0 +1 @@
.env

View File

@@ -1,34 +1,48 @@
# Use LinuxServer.io Duplicati base
FROM linuxserver/duplicati:2.1.0
# Install Docker CLI, bash, python3
RUN apt-get update && \
DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
# Install Docker CLI, bash, python3, btrfs support and all the app directories
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
ca-certificates \
curl \
gnupg \
lsb-release \
bash \
python3 \
python3-pip \
docker.io \
btrfs-progs \
ca-certificates curl && \
rm -rf /var/lib/apt/lists/*
&& mkdir -p /etc/apt/keyrings \
&& curl -fsSL "https://download.docker.com/linux/$(. /etc/os-release; echo "$ID")/gpg" \
| gpg --dearmor -o /etc/apt/keyrings/docker.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] \
https://download.docker.com/linux/$(. /etc/os-release; echo "$ID") \
$(lsb_release -cs) stable" \
| tee /etc/apt/sources.list.d/docker.list > /dev/null \
&& apt-get update \
&& apt-get install -y --no-install-recommends \
docker-ce-cli \
&& groupadd -f docker \
&& usermod -aG docker abc \
&& rm -rf /var/lib/apt/lists/* \
&& mkdir -p /usr/local/bin /config /etc/services.d/backupbot
# Create directories for backup scripts and logs
RUN mkdir -p /usr/local/bin /config/log /config/web /etc/services.d/backupbot
# Copy backup script
# Copy the backup script
COPY backup.sh /usr/local/bin/backup.sh
RUN chmod +x /usr/local/bin/backup.sh
# Copy the environment variables for the config
COPY backupbot.env /defaults/backupbot.env
# Copy the environment variables for backupbot
COPY backupbot.conf /defaults/backupbot.conf
RUN chown www-data:www-data /defaults/backupbot.conf \
&& chmod 644 /defaults/backupbot.conf
# Copy s6 service for backupbot
COPY services/backupbot/run /etc/services.d/backupbot/run
RUN chmod +x /etc/services.d/backupbot/run
# Copy web frontend
COPY web /defaults/web
RUN chmod +x /defaults/web/cgi-bin/backupbot.cgi
COPY web /app
RUN chmod +x /app/cgi-bin/backupbot.cgi
# Expose web frontend port
EXPOSE 8080

View File

@@ -4,7 +4,6 @@
# Author: Calahil Studios
# === CONFIGURATION ===
LOG_FILE="$1"
BACKUP_DIR="/backups/postgres_dumps"
RETENTION_DAYS="${RETENTION_DAYS:-7}" # Keep 7 days of backups
@@ -19,12 +18,12 @@ ghcr.io/immich-app/postgres:14-vectorchord0.4.3-pgvectors0.2.0
EOF
)
echo "[BACKUPBOT_INFO] Starting PostgreSQL backup service..." | tee -a "$LOG_FILE"
echo "[BACKUPBOT_INFO] Starting PostgreSQL backup service..."
mkdir -p "$BACKUP_DIR"
TIMESTAMP=$(date +'%Y-%m-%d_%H-%M-%S')
echo "[BACKUPBOT_INFO] $(date) - Starting backup cycle ($TIMESTAMP)" | tee -a "$LOG_FILE"
echo "[BACKUPBOT_INFO] Checking for running Postgres containers..." | tee -a "$LOG_FILE"
echo "[BACKUPBOT_INFO] $(date) - Starting backup cycle ($TIMESTAMP)"
echo "[BACKUPBOT_INFO] Checking for running Postgres containers..."
# Find running containers matching known image names
MATCHING_CONTAINERS=$(
@@ -41,7 +40,7 @@ MATCHING_CONTAINERS=$(
)
if [ -z "$MATCHING_CONTAINERS" ]; then
echo "[BACKUPBOT_WARN] No Postgres containers found." | tee -a "$LOG_FILE"
echo "[BACKUPBOT_WARN] No Postgres containers found."
else
for container in $MATCHING_CONTAINERS; do
NAME=$(docker inspect --format '{{.Name}}' "$container" | sed 's#^/##')
@@ -54,16 +53,16 @@ else
PG_USER=$(docker inspect --format '{{range .Config.Env}}{{println .}}{{end}}' "$container" | grep POSTGRES_USER | cut -d= -f2)
PG_PASS=$(docker inspect --format '{{range .Config.Env}}{{println .}}{{end}}' "$container" | grep POSTGRES_PASSWORD | cut -d= -f2)
if docker exec -e PGPASSWORD="$PG_PASS" "$container" pg_dumpall -U "$PG_USER" -h 127.0.0.1 >"$FILE" 2>/tmp/pg_backup_error.log; then
echo "[BACKUPBOT_SUCCESS] Backup complete for $NAME -> $FILE" | tee -a "$LOG_FILE"
echo "[BACKUPBOT_SUCCESS] Backup complete for $NAME -> $FILE"
else
echo "[BACKUPBOT_ERROR] Backup failed for $NAME (check /tmp/pg_backup_error.log)" | tee -a "$LOG_FILE"
echo "[BACKUPBOT_ERROR] Backup failed for $NAME (check /tmp/pg_backup_error.log)"
fi
# Retention cleanup
find "$CONTAINER_BACKUP_DIR" -type f -mtime +$RETENTION_DAYS -name '*.sql' -delete
done
fi
echo "[BACKUPBOT_INFO] Creating a snapshot of /srv/appdata" | tee -a "$LOG_FILE"
echo "[BACKUPBOT_INFO] Creating a snapshot of /srv/appdata"
btrfs subvolume snapshot -r /source/appdata /backups/snapshots/$(hostname)-$(date +%F)
echo "[BACKUPBOT_INFO] Backup cycle complete." | tee -a "$LOG_FILE"
echo "[BACKUPBOT_INFO] Backup cycle complete."

View File

@@ -6,3 +6,4 @@ GOTIFY_URL=http://gotify.example.com
GOTIFY_TOKEN=your_gotify_token_here
BACKUP_HOUR=03
BACKUP_MINUTE=00
BACKUPBOT_WEB_LOGGING=DEBUG

View File

@@ -1,22 +1,23 @@
services:
backupbot:
image: gitea.calahilstudios.com/calahil/backupbot:latest
build: .
container_name: backupbot
privileged: true
environment:
- PUID=0
- PGID=0
- TZ=America/Los_Angeles
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- SETTINGS_ENCRYPTION_KEY=${KEY}
- CLI_ARGS= #optional
- DUPLICATI__WEBSERVICE_PASSWORD=${PASSWORD}
volumes:
# Config dir for duplicati
- /srv/appdata/duplicati/config:/config
# Backup folder to store dumps/backups/snapshots
- /srv/backups:/backups
# Backup folder to store dumps/backups
- /srv/backups:/backups:rshared
# Docker socket to list containers
- /var/run/docker.sock:/var/run/docker.sock:ro
ports:
- 8200:8200
- 8201:8080

View File

@@ -1,31 +1,25 @@
#!/usr/bin/with-contenv bash
set -e
# Source env if available
if [[ -f /config/backupbot.env ]]; then
if [[ -f /config/backupbot.conf ]]; then
set -a
source /config/backupbot.env
source /config/backupbot.conf
set +a
else
echo "[INFO] copying env vars from defaults..."
cp -r /defaults/backupbot.env /config/
echo "[INFO] copying config vars from defaults..."
cp -r /defaults/backupbot.conf /config/
set -a
source /config/backupbot.env
source /config/backupbot.conf
set +a
fi
# Initialize default web interface if missing
if [ ! -d /config/web ]; then
echo "[INFO] Populating /config/web from defaults..."
cp -r /defaults/web /config/
fi
# Start Python HTTP server for web config in background
cd /config/web
nohup python3 -m http.server 8080 --cgi >/config/log/web.log 2>&1 &
cd /app
nohup python3 -m http.server 8080 --cgi 2>&1 &
# Start backup scheduler
STATE_FILE="/config/last_backup_date"
LOG_FILE="/config/log/pgbackup.log"
mkdir -p "$(dirname "$STATE_FILE")" "$(dirname "$LOG_FILE")"
# TZ
: "${TZ:=UTC}"
@@ -50,7 +44,7 @@ run_backup() {
local attempt=1
while ((attempt <= RETRIES)); do
echo "[INFO] Backup attempt $attempt"
if /usr/local/bin/backup.sh "$LOG_FILE"; then
if /usr/local/bin/backup.sh; then
echo "[SUCCESS] Backup completed"
return 0
else

View File

@@ -3,34 +3,87 @@ import cgi
import cgitb
import os
import json
from pathlib import Path
import sys
import traceback
import tempfile
cgitb.enable()
ENV_FILE = Path("/config/backupbot.env")
print("Content-Type: application/json\n")
ENV_FILE = "/config/backupbot.conf"
ZONEINFO_DIR = "/usr/share/zoneinfo"
# Logging level from environment
LOG_LEVEL = os.environ.get("BACKUPBOT_WEB_LOGGING", "info").lower()
LOG_LEVELS = {"debug": 3, "info": 2, "warn": 1}
def log(level, message, exc=None):
"""
Docker-friendly logging.
level: "debug", "info", "warn"
exc: exception object (only used in debug)
"""
if LOG_LEVELS.get(level, 0) <= LOG_LEVELS.get(LOG_LEVEL, 0):
timestamp = (
__import__("datetime")
.datetime.now()
.strftime(
"%Y-%m-%d \
%H:%M:%S"
)
)
msg = f"[{timestamp}] [{level.upper()}] {message}"
print(msg, file=sys.stderr)
if exc and LOG_LEVEL == "debug":
traceback.print_exception(
type(exc), exc, exc.__traceback__, file=sys.stderr
)
def read_env():
env = {}
if ENV_FILE.exists():
with ENV_FILE.open() as f:
if os.path.exists(ENV_FILE):
try:
with open(ENV_FILE) as f:
for line in f:
line = line.strip()
if not line or line.startswith("#") or "=" not in line:
if not line or "=" not in line:
continue
key, val = line.split("=", 1)
env[key.strip()] = val.strip().split("#")[0].strip()
env[key.strip()] = val.strip()
except Exception as e:
log("warn", f"Failed to read config: {e}", e)
return env
def write_env(env):
# Rotate the old env file just in case
if ENV_FILE.exists():
ENV_FILE.replace(ENV_FILE.with_suffix(".env.bak"))
with ENV_FILE.open("w") as f:
try:
dir_name = os.path.dirname(ENV_FILE)
os.makedirs(dir_name, exist_ok=True)
# Write atomically to temp file
with tempfile.NamedTemporaryFile("w", dir=dir_name, delete=False) as tmp:
for key, val in env.items():
f.write(f"{key}={val}\n")
tmp.write(f"{key}={val}\n")
temp_name = tmp.name
os.replace(temp_name, ENV_FILE)
log("info", f"Configuration saved to {ENV_FILE}")
except Exception as e:
log("warn", f"Failed to write config: {e}", e)
raise
def list_timezones():
zones = []
for root, _, files in os.walk(ZONEINFO_DIR):
rel_root = os.path.relpath(root, ZONEINFO_DIR)
if rel_root.startswith(("posix", "right")):
continue
for file in files:
if file.startswith(".") or file.endswith((".tab", ".zi")):
continue
zones.append(os.path.join(rel_root, file) if rel_root != "." else file)
return sorted(zones)
form = cgi.FieldStorage()
@@ -38,13 +91,25 @@ action = form.getvalue("action")
try:
if action == "get":
print(json.dumps(read_env()))
env = read_env()
log("debug", f"Returning configuration: {env}")
print(json.dumps(env))
elif action == "set":
length = int(os.environ.get("CONTENT_LENGTH", "0"))
raw_len = os.environ.get("CONTENT_LENGTH")
length = int(raw_len) if raw_len else 0
data = json.loads(os.read(0, length))
write_env(data)
log("debug", f"Received new configuration: {data}")
env = read_env()
env.update(data) # update existing keys, add new keys
write_env(env)
print(json.dumps({"status": "ok", "message": "Configuration saved."}))
elif action == "get_timezones":
zones = list_timezones()
log("debug", f"Returning {len(zones)} timezones")
print(json.dumps({"timezones": zones}))
else:
log("warn", f"Invalid action requested: {action}")
print(json.dumps({"status": "error", "message": "Invalid action"}))
except Exception as e:
log("warn", f"Unhandled exception: {e}", e)
print(json.dumps({"status": "error", "message": str(e)}))

View File

@@ -32,13 +32,17 @@
<form id="configForm">
<label>Timezone:
<input type="text" name="TZ">
<select id="tzSelect" name="TZ">
<option value="">Loading...</option>
</select>
</label>
<label>Backup Directory:
<input type="text" name="BACKUP_DIR">
<input type="text" name="BACKUP_DIR" id="backupDir" placeholder="/backups">
<button type="button" onclick="chooseBackupDir()">Browse</button>
</label>
<label>Log File:
<input type="text" name="LOG_FILE">
<input type="text" name="LOG_FILE" id="logDir" placeholder="/config/log">
<button type="button" onclick="chooseLogDir()">Browse</button>
</label>
<label>Backup Hour:
<input type="number" name="BACKUP_HOUR" min="0" max="23">
@@ -61,6 +65,29 @@
<p id="status"></p>
<script>
async function loadTimezones() {
const res = await fetch('/cgi-bin/backupbot.cgi?action=get_timezones');
const data = await res.json();
const select = document.getElementById('tzSelect');
select.innerHTML = '';
data.timezones.forEach(tz => {
const opt = document.createElement('option');
opt.value = tz;
opt.textContent = tz;
select.appendChild(opt);
});
}
function chooseBackupDir() {
const base = prompt("Enter or confirm your backup directory path:", "/backups");
if (base) document.getElementById('backupDir').value = base;
}
function chooseLogDir() {
const base = prompt("Enter or confirm your log directory path:", "/config/log");
if (base) document.getElementById('logDir').value = base;
}
async function loadConfig() {
const res = await fetch('/cgi-bin/backupbot.cgi?action=get');
const data = await res.json();
@@ -84,7 +111,7 @@
}
document.getElementById('configForm').addEventListener('submit', saveConfig);
loadConfig();
loadTimezones().then(loadConfig);
</script>
</body>