aterfax/pbs-client repository overview

⁠Proxmox Backup Server Client - Dockerized

⁠Summary

See: https://github.com/Aterfax/pbs-client-docker⁠

A lightweight container for running the Proxmox Backup Server (PBS) client, allowing you to back up any directories bind mounted into /backups. Supports automatic or user-provided encryption keys, cron-scheduled or manual backups, and includes helper scripts for convenience. Use the provided Docker Hub image or build locally, bind-mount your data, configure via .env, and check first-run logs to save generated keys and passwords securely.

Encrypting your backups is strongly recommended and the default!

See the GitHub repository for configuration examples, troubleshooting, and descriptions of the helper scripts.

⁠Features

• Multiarch compatible - Runs on x86_64 and arm64.
• Containerized PBS Client - Runs Proxmox Backup Server client in a Docker container.
• Automated Backup Scheduling - Fully configurable via CRON_SCHEDULE and optional CRON_BACKUP_ONLY.
• Secure Backups - Supports encrypted backups with PBS_ENCRYPTION_PASSWORD or unencrypted mode if needed.
• API Key Support - Use PBS_API_KEY_NAME / PBS_API_KEY_SECRET instead of PBS username/password.
• Namespace Support - Target specific PBS datastore namespaces with PBS_DATASTORE_NS.
• Customizable Backup Options - Append extra PBS CLI options via PBS_BACKUP_CMD_APPEND_EXTRA_OPTS and restore options via PBS_RESTORE_CMD_APPEND_EXTRA_OPTS.
• Healthchecks.io Integration - Optional monitoring via self-hosted or central Healthchecks.io.
• Email Notifications - Optional success/failure notifications via SMTP configuration.
• Timezone Configurable - Set container timezone with TZ.
• S6-based Supervision - Long-running container managed with s6, optional mail service, and clean logging.