About pbs-plus

A Proxmox Backup Server (PBS) "extension" server that aims to add features and make PBS a true alternative to Veeam.

p

Published by

README.md

Proxmox Backup Server (PBS) Plus

Advanced backup features for Proxmox Backup Server — file-level backup/restore, FUSE archive mounting with journal overlays, and a Kubernetes operator.

[!WARNING] Pre-1.0. Expect breaking changes on every release.

Quick Links

Topic	Document
How it works, architecture, ports	Architecture
Server, agent, container, operator install	Installation
Backup/restore jobs, S3 targets, hook scripts, database dumps	Usage
Read/write FUSE mount for PBS archives	pxar-mount
K8s operator for annotated PVCs	Kubernetes Operator
CI workflows and E2E testing	Development

Installation

Server — install the .deb on your PBS machine, then:

echo "PBS_PLUS_HOSTNAME=$(hostname -f)" >> /etc/proxmox-backup/pbs-plus/pbs-plus.env
systemctl restart pbs-plus

Agent (Linux) — install the package, set env vars, restart:

echo "PBS_PLUS_INIT_SERVER_URL=https://<pbs>:8008" >> /etc/pbs-plus-agent/registry.toml
echo "PBS_PLUS_INIT_BOOTSTRAP_TOKEN=<token>" >> /etc/pbs-plus-agent/registry.toml
echo "PBS_PLUS_HOSTNAME=$(hostname -f)" >> /etc/default/pbs-plus-agent
systemctl restart pbs-plus-agent

Agent (Docker):

docker run -d --name pbs-plus-agent \
  --cap-add=DAC_READ_SEARCH \
  -e PBS_PLUS_INIT_SERVER_URL="https://<pbs>:8008" \
  -e PBS_PLUS_INIT_BOOTSTRAP_TOKEN="<token>" \
  -e PBS_PLUS_HOSTNAME="$(hostname -f)" \
  -v /srv/pbs-plus-agent/lib:/var/lib/pbs-plus-agent \
  -v /srv/pbs-plus-agent/log:/var/log/pbs-plus-agent \
  -v /srv/pbs-plus-agent/etc:/etc/pbs-plus-agent \
  ghcr.io/pbs-plus/pbs-plus-agent:latest

See Installation for Windows agent, Kubernetes operator, and details.

Contributing

PRs welcome. See Development for CI and test details.

License

MIT

pbs-plus