Directories
¶
| Path | Synopsis |
|---|---|
|
agent
|
|
|
backup
Package backup runs filesystem backups from the agent into Proxmox Backup Server with gopbs, over a session the FallBCK server opened on the agent's behalf.
|
Package backup runs filesystem backups from the agent into Proxmox Backup Server with gopbs, over a session the FallBCK server opened on the agent's behalf. |
|
credstore
Package credstore is the agent's encrypted store for database credential profiles.
|
Package credstore is the agent's encrypted store for database credential profiles. |
|
dbbackup
Package dbbackup executes database backups on fallbck-agent (and, through the db-worker mode, inside kubernetes dump pods): it detects the client tools, checks the server, dumps into a spool directory, writes the manifest and hands the spool to the pxar upload engine.
|
Package dbbackup executes database backups on fallbck-agent (and, through the db-worker mode, inside kubernetes dump pods): it detects the client tools, checks the server, dumps into a spool directory, writes the manifest and hands the spool to the pxar upload engine. |
|
dockerbackup
Package dockerbackup runs Docker host backups from the filesystem agent: it collects container, network, volume and image definitions plus compose files into a spool directory, archives them together with every named volume, and generates a restore runbook.
|
Package dockerbackup runs Docker host backups from the filesystem agent: it collects container, network, volume and image definitions plus compose files into a spool directory, archives them together with every named volume, and generates a restore runbook. |
|
enrollment
Package enrollment registers an agent with the FallBCK server using a one-time token
|
Package enrollment registers an agent with the FallBCK server using a one-time token |
|
k8sbackup
Package k8sbackup implements the Kubernetes backup agent: API resource dumps, PVC snapshots/clones, worker-pod supervision and the Secret-backed identity.
|
Package k8sbackup implements the Kubernetes backup agent: API resource dumps, PVC snapshots/clones, worker-pod supervision and the Secret-backed identity. |
|
m365
Package m365 executes Microsoft 365 backup jobs on the agent: it talks to Microsoft Graph, keeps a per-unit index of what the previous snapshot held, presents each user, site or team as a virtual tree whose unchanged items are never fetched, and uploads one snapshot per unit through the shared backup engine.
|
Package m365 executes Microsoft 365 backup jobs on the agent: it talks to Microsoft Graph, keeps a per-unit index of what the previous snapshot held, presents each user, site or team as a virtual tree whose unchanged items are never fetched, and uploads one snapshot per unit through the shared backup engine. |
|
pvebackup
Package pvebackup runs Proxmox VE host backups from the filesystem agent: it collects the node's configuration and inventory into a spool directory, archives it together with /etc, /root and optional data paths, and generates a restore runbook.
|
Package pvebackup runs Proxmox VE host backups from the filesystem agent: it collects the node's configuration and inventory into a spool directory, archives it together with /etc, /root and optional data paths, and generates a restore runbook. |
|
runtime
Package runtime is the shared daemon skeleton of the fallbck agents: configuration lookup and self-enrollment, the Temporal client and PBS tunnel connections through the server gateway, the activity worker, and the heartbeat / token-rotation loop.
|
Package runtime is the shared daemon skeleton of the fallbck agents: configuration lookup and self-enrollment, the Temporal client and PBS tunnel connections through the server gateway, the activity worker, and the heartbeat / token-rotation loop. |
|
vss
Package vss backs Windows backups with Volume Shadow Copies: every volume a job's paths live on is snapshotted, the shadow copy is exposed through a directory symlink under the agent's data directory, and the job's paths are remapped onto it so open and locked files are read from a consistent point in time.
|
Package vss backs Windows backups with Volume Shadow Copies: every volume a job's paths live on is snapshotted, the shadow copy is exposed through a directory symlink under the agent's data directory, and the job's paths are remapped onto it so open and locked files are read from a consistent point in time. |
|
Package agenthealth derives the alerts the agent status page shows from what the server already knows: heartbeats, the inventory summary, the agent's jobs and their newest runs, and the server version.
|
Package agenthealth derives the alerts the agent status page shows from what the server already knows: heartbeats, the inventory summary, the agent's jobs and their newest runs, and the server version. |
|
Package agentupdate mirrors the fallbck-agent release of the server's own version for agents that update themselves.
|
Package agentupdate mirrors the fallbck-agent release of the server's own version for agents that update themselves. |
|
Package audit keeps the audit log bounded: a daily prune deletes entries older than the retention, after handing them to the configured export so they still exist somewhere.
|
Package audit keeps the audit log bounded: a daily prune deletes entries older than the retention, after handing them to the configured export so they still exist somewhere. |
|
Package dbbackup holds the database backup job specification, agent-side credential profiles and the run manifest.
|
Package dbbackup holds the database backup job specification, agent-side credential profiles and the run manifest. |
|
Package dockerbackup holds the Docker host backup job specification, the agent-side settings and the run manifest.
|
Package dockerbackup holds the Docker host backup job specification, the agent-side settings and the run manifest. |
|
Package fsutil holds the small filesystem helpers shared by the agents (tree copies for spooling and migration) and by the job specs (archive entry names).
|
Package fsutil holds the small filesystem helpers shared by the agents (tree copies for spooling and migration) and by the job specs (archive entry names). |
|
Package gateway exposes a narrow, authenticated slice of the Temporal WorkflowService to backup agents on the server's public port.
|
Package gateway exposes a narrow, authenticated slice of the Temporal WorkflowService to backup agents on the server's public port. |
|
Package inventory is what an agent knows about its host and reports to the server: a compact Summary every few minutes with the heartbeat, and the full Detail on demand (the status page's Refresh).
|
Package inventory is what an agent knows about its host and reports to the server: a compact Summary every few minutes with the heartbeat, and the full Detail on demand (the status page's Refresh). |
|
Package k8sbackup holds the Kubernetes backup job specification (backup_jobs.k8s_config), the discovery plan exchanged between server and agent, and the run manifest.
|
Package k8sbackup holds the Kubernetes backup job specification (backup_jobs.k8s_config), the discovery plan exchanged between server and agent, and the run manifest. |
|
Package m365 holds the Microsoft 365 backup job specification, the tenant (Entra app registration) model, the Graph credential flow and the run manifest.
|
Package m365 holds the Microsoft 365 backup job specification, the tenant (Entra app registration) model, the Graph credential flow and the run manifest. |
|
Package pbs holds the server's Proxmox Backup Server helpers: API token parsing, key files and the token permission check.
|
Package pbs holds the server's Proxmox Backup Server helpers: API token parsing, key files and the token permission check. |
|
Package proxy carries agents' Proxmox Backup Server sessions through the FallBCK server.
|
Package proxy carries agents' Proxmox Backup Server sessions through the FallBCK server. |
|
pbstest
Package pbstest is a minimal fake Proxmox Backup Server for tests: it accepts the backup-protocol upgrade over TLS and implements the session endpoints gopbs uses (dynamic index create/append/close, chunk and blob upload, previous, finish).
|
Package pbstest is a minimal fake Proxmox Backup Server for tests: it accepts the backup-protocol upgrade over TLS and implements the session endpoints gopbs uses (dynamic index create/append/close, chunk and blob upload, previous, finish). |
|
Package pvebackup holds the Proxmox VE host backup job specification and run manifest.
|
Package pvebackup holds the Proxmox VE host backup job specification and run manifest. |
|
Package releasesig verifies that a release's checksums file carries a valid Sigstore (cosign keyless) signature from this project's GitHub release workflow, and looks artifacts up in that signed file.
|
Package releasesig verifies that a release's checksums file carries a valid Sigstore (cosign keyless) signature from this project's GitHub release workflow, and looks artifacts up in that signed file. |
|
Package rundetail holds the type-specific detail blob stored per backup run (backup_runs.details) and rendered on the run detail page.
|
Package rundetail holds the type-specific detail blob stored per backup run (backup_runs.details) and rendered on the run detail page. |
|
Package secrets seals the server's stored secrets (PBS API tokens, backup encryption keys) with a master key held outside the database, so a database dump alone does not expose them.
|
Package secrets seals the server's stored secrets (PBS API tokens, backup encryption keys) with a master key held outside the database, so a database dump alone does not expose them. |
|
activities
Package activities defines the activities executed by the client backup agent.
|
Package activities defines the activities executed by the client backup agent. |
|
embedded
Package embedded runs the Temporal server in-process inside fallbck-server.
|
Package embedded runs the Temporal server in-process inside fallbck-server. |
|
scheduler
Package scheduler keeps one Temporal Schedule per backup job with a cron expression.
|
Package scheduler keeps one Temporal Schedule per backup job with a cron expression. |
|
ui
Package ui embeds the Temporal Web UI (temporalio/ui-server) in fallbck-server.
|
Package ui embeds the Temporal Web UI (temporalio/ui-server) in fallbck-server. |
|
Package tokencheck keeps an eye on the PBS API tokens of backup targets: each one should hold Datastore.Backup within its datastore and nothing else.
|
Package tokencheck keeps an eye on the PBS API tokens of backup targets: each one should hold Datastore.Backup within its datastore and nothing else. |
Click to show internal directories.
Click to hide internal directories.