Admin area guide

Admin overview

After you log in, you see the admin dashboard. The left sidebar is the main navigation:

• Home — Dashboard with counts, last runs, and quick actions.
• Inventory — VPS and Backup Nodes.
• Backup — Backup Jobs and Backup Runs.
• Restore — Restore Jobs, Restore Runs, and Cleanup.
• System — Settings, Health, and Users.

Use the links in this doc to jump to each area. All times in the admin are shown in the configured timezone (e.g. America/Phoenix).

Home / Dashboard

The dashboard gives you a quick overview:

• Counts for VPS, backup nodes, backup jobs, and restore jobs.
• Last backup run and last restore run (when and status).
• Recent activity or alerts, if any.
• Quick actions (e.g. links to create a backup job, run a job, or open Health).

Use it to see at a glance whether backups are running and where to go next.

Inventory → VPS

VPS are the servers you back up (sources) or restore to (targets).

List

The VPS list shows all registered VPS with key fields (e.g. hostname, IP, notes). You can search or filter to find a specific server.

Create

Click Add VPS (or equivalent). Enter hostname, IP, SSH port if not 22, and any notes. Save to create the record.

Edit / View / Delete

From the list, open a VPS to view details. You can edit the same fields or delete the VPS if it is no longer used (ensure no backup or restore jobs depend on it).

Inventory → Backup Nodes

Backup nodes are the servers that store backup data. Each backup job sends data to a chosen backup node.

List

The Backup Nodes list shows all nodes with connection and setup status. You can see which nodes are reachable and which have the backup agent installed.

Create

Add a new backup node: hostname, IP, SSH port, and any options. Save to create the record.

Edit / View / Runs

Open a node to edit it, view its details, or see backup/restore runs that use this node. Use the node’s SSH/setup instructions or Install agent (or equivalent) if the node needs the backup agent installed.

Backup → Backup Jobs

Backup jobs define what to back up, where, and how often.

Create

Create a backup job by choosing: source VPS, backup node, schedule (cron expression), and any options (e.g. what to include). Save the job.

Edit / View / Delete

From the list, open a job to edit it, view its configuration, or delete it. You can filter the list by status (e.g. active) if the UI supports it.

Run now

Each job can be run on demand. Use Run now (dry) to simulate without writing data, or Run now (live) to perform a real backup. The run appears under Backup → Backup Runs.

Backup → Backup Runs

Every time a backup job runs (scheduled or on demand), a backup run record is created.

• List — View all backup runs; filter by result (e.g. success, failed) and optionally by job or date.
• View — Open a run to see details and logs (start/end time, output, errors).
• Delete — Remove individual run records when you no longer need them.

Backup → Cleanup old runs

The cleanup page lets you remove old backup run records in bulk (e.g. older than a certain number of days or keep only the last N). Use it to keep the database and lists manageable. Default retention is 90 days (configurable via BACKUP_RUN_RETENTION_DAYS in .env).

Restore → Restore Jobs

Restore jobs define how to restore or sync data from a backup node to a target VPS.

Create

Create a restore job by choosing: source backup node (and optionally backup job/snapshot), target VPS, and options. Save the job.

Edit / View / Delete

Open a restore job to edit it, view configuration, or delete it.

Run

Run a restore on demand: Dry run (simulate), Live restore, or Full sync (sync from backup to target). The run appears under Restore → Restore Runs.

Restore → Restore Runs

Each restore execution creates a restore run record.

• List — View all restore runs; filter by result and optionally by job or date.
• View — Open a run to see details and logs.
• Delete — Remove individual run records when no longer needed.

Restore → Cleanup old runs

The cleanup page lets you remove old restore run records in bulk (e.g. older than a certain number of days or keep only the last N). Use it to keep the database and lists manageable. Backup runs may have a similar cleanup option in Backup Runs or Settings.

System → Settings

The Settings page typically includes:

• Cron — The command to add to the server crontab so scheduled backup (and optionally restore) jobs run automatically. Copy and install it on the server that runs FaizeDome.
• Users — Link to manage admin users (or a shortcut to Users).
• Change password — Change the current user’s password.
• Database migrations — Run pending DB migrations to keep the schema up to date after an upgrade.
• Backup health — Link to the Health page to see at-risk backup jobs.

System → Health

The Health view shows backup jobs that may need attention—for example, jobs with no recent successful run or with repeated failures. The table is sortable (e.g. by last run time or status) so you can prioritize which jobs to fix or run manually. Use this page regularly to ensure critical backups are healthy.

System → Users

Admin users can log in to the dashboard. From Users you can:

• Create — Add a new user (username and password).
• Edit — Change a user’s password or details.
• Delete — Remove a user (you cannot delete your own account while logged in as that user, or the last admin).