plugin backup

Backup Plugin

Automated PostgreSQL backups with scheduling and optional cloud upload. Free, MIT licensed.

Install

nself plugin install backup

What It Does

Runs scheduled pg_dump backups of your Postgres database with configurable retention policies. Supports uploading backups to S3-compatible storage (MinIO or any S3 provider). Free tier handles standard scheduling. See plugin-backup-pro for encryption and point-in-time recovery.

Configuration

Env Var	Default	Description
BACKUP_PORT	3050	Backup service port
BACKUP_SCHEDULE	0 2 * * *	Cron schedule (default: 2am daily)
BACKUP_RETENTION_DAYS	7	Days to keep backups
BACKUP_S3_BUCKET	—	S3/MinIO bucket name (optional)
BACKUP_S3_ENDPOINT	—	S3 endpoint URL (optional)

Ports

Port	Purpose
3050	Backup service REST API

Database Tables

2 tables added to your Postgres database:

• np_backup_jobs, backup job history and status
• np_backup_schedules, configured backup schedules

Nginx Routes

None, backup service is internal only.

API

GET  /health           — Health check
GET  /backups          — List backup history
POST /backups/trigger  — Trigger immediate backup
POST /backups/restore  — Restore from backup