Files
gniza4cp/etc/remote.conf.example
shuki 1459bd1b8b Initial commit: gniza backup & disaster recovery CLI + WHM plugin
Full-featured cPanel backup tool with SSH, S3, and Google Drive support.
Includes WHM plugin with Tailwind/DaisyUI UI, multi-remote management,
decoupled schedules, and account restore workflows.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-04 02:39:39 +02:00

41 lines
2.6 KiB
Plaintext

# gniza remote destination config
# Copy to /etc/gniza/remotes.d/<name>.conf and edit
#
# Each file in /etc/gniza/remotes.d/ defines a remote backup destination.
# The filename (without .conf) is the remote name used with --remote=NAME.
# ── Remote Type ───────────────────────────────────────────────
# "ssh" (default), "s3" (Amazon S3 / S3-compatible), or "gdrive" (Google Drive)
REMOTE_TYPE="ssh"
# ── SSH Remote (REMOTE_TYPE="ssh") ────────────────────────────
REMOTE_HOST="" # Required: hostname or IP
REMOTE_PORT=22 # SSH port
REMOTE_USER="root" # SSH user
REMOTE_AUTH_METHOD="key" # "key" (SSH key) or "password" (sshpass)
REMOTE_KEY="/root/.ssh/id_rsa" # Path to SSH private key (key mode only)
REMOTE_PASSWORD="" # SSH password (password mode only, requires sshpass)
# ── S3 Remote (REMOTE_TYPE="s3") ─────────────────────────────
# Works with AWS S3, MinIO, Wasabi, Backblaze B2, and other S3-compatible services.
# Requires rclone installed on the server.
S3_ACCESS_KEY_ID="" # Required: S3 access key
S3_SECRET_ACCESS_KEY="" # Required: S3 secret key
S3_REGION="us-east-1" # AWS region (default: us-east-1)
S3_ENDPOINT="" # Optional: custom endpoint for S3-compatible services
S3_BUCKET="" # Required: bucket name
# ── Google Drive Remote (REMOTE_TYPE="gdrive") ───────────────
# Uses a service account for authentication. Requires rclone installed.
# Create a service account at https://console.cloud.google.com/iam-admin/serviceaccounts
GDRIVE_SERVICE_ACCOUNT_FILE="" # Required: path to service account JSON key file
GDRIVE_ROOT_FOLDER_ID="" # Optional: root folder ID to use as base
# ── Common Settings ───────────────────────────────────────────
REMOTE_BASE="/backups" # Base directory/path on remote
BWLIMIT=0 # Bandwidth limit in KB/s, 0 = unlimited
RSYNC_EXTRA_OPTS="" # Extra options to pass to rsync (SSH only)
# ── Retention ─────────────────────────────────────────────────
RETENTION_COUNT=30 # Number of snapshots to keep per account