Usage & Commands
Complete reference for all PanelAlpha Snapshot Tool commands.
Command Reference
Snapshot Operations
Create a Snapshot
Creates a complete backup of your PanelAlpha installation including databases, Docker volumes, and configuration files.
List Snapshots
Displays all available snapshots with their IDs, dates, and sizes.
Delete a Snapshot
Remove a specific snapshot by its ID (e.g., a1b2c3d4).
Restore Operations
Restore Latest Snapshot
Restores from the most recent snapshot.
Restore Specific Snapshot
Restores from a specific snapshot (e.g., a1b2c3d4).
⚠️ Warning: Restoration will replace all current data!
Automation
Install Cron Job
Sets up automatic daily snapshots.
Check Cron Status
Shows current automation status and next scheduled run.
Remove Cron Job
Disables automatic snapshots.
Setup & Configuration
Interactive Setup
Launches the interactive setup wizard for configuring storage backend.
Install Dependencies
Installs required tools and sets up the environment.
Test Connection
Verifies connectivity to the configured storage backend.
What Gets Captured
Databases
| Component | Description |
|---|---|
| PanelAlpha API Database | Complete MySQL dump with routines and triggers |
| Matomo Database | Analytics and statistics data |
| Users Databases | (Engine only) Per-user databases |
Docker Volumes
| Volume | Description |
|---|---|
api-storage |
PanelAlpha application data |
database-api-data |
MySQL data files |
redis-data |
Cache and session data |
core-storage |
(Engine only) Core application data |
Configuration Files
| File/Directory | Description |
|---|---|
docker-compose.yml |
Container orchestration configuration |
.env files |
Environment variables and secrets |
packages/ |
Custom packages and extensions |
| SSL certificates | Let's Encrypt certificates |
| Nginx configurations | Web server settings |
Common Workflows
Daily Backup Routine
# Create snapshot
sudo ./pasnap.sh --snapshot
# Verify it was created
sudo ./pasnap.sh --list-snapshots
Before Major Changes
# Create a snapshot before updates
sudo ./pasnap.sh --snapshot
# Note the snapshot ID for potential rollback
sudo ./pasnap.sh --list-snapshots