Version 3.12.1
Stable v 3.12.1
1. Introduction
1.1. Overview
1.2. Features
2. Quickstart
2.1. System requirements
2.2. How to install?
2.2.1. On premise
2.2.2. Docker-compose
2.2.3. Kubernetes/Openshift
2.3. How to configure?
2.3.1. On premise
2.3.2. Docker-compose
2.3.3. Kubernetes/OpenShift
3. Usage
3.1. Preparing of the main config
3.2. Files backups
3.2.1. Discrete files backups
3.2.2. Incremental files backups
3.3. Database backups
3.3.1. MySQL/MariaDB logical backups
3.3.2. MySQL/MariaDB physical backups
3.3.3. PostgreSQL logical backups
3.3.4. PostgreSQL physical backups
3.3.5. MongoDB backups
3.3.6. Redis backups
3.4. User-defined scripts
3.4.1. User-defined scripts that extend functionality
3.5. Job storage options
3.5.1. Job storage options
3.6. Remote storage connections
3.6.1. S3
3.6.2. SFTP/SCP
3.6.3. SMB/CIFS
3.6.4. NFS
3.6.5. FTP/FTPS
3.6.6. WebDav
3.7. Notifications
3.7.1. Email
3.7.2. Slack
3.7.3. Telegram
3.7.4. Custom hook
3.8. Monitoring
3.8.1. Server config
3.8.2. Start metrics server
3.8.3. Scrape the nxs-backup metrics
3.9. Limitations for resources
3.9.1 Local disk rate
3.9.2. Remote storage rate
3.9.3. CPU limit
4. Restore
4.1. List backups
4.2. Files backups
4.2.1. Discrete files backups
4.2.2. Incremental files backups
4.3. Database backups
4.3.1. MySQL logical
4.3.2. MySQL physical (Xtrabackup)
4.3.3. PSQL logical
4.3.4. PSQL physical
4.3.5. MongoDB
4.3.6. Redis
4.4. User-defined script backup
4.4.1. User-defined script backup

1.2. Features

Here is a list of the main features that nxs-backup provides.

  • Full data backup
    • Files backups:
      • Discrete
      • Incremental
    • Database backups:
      • Discrete
      • Logical backups of MySQL/Percona (5.7/8.0/all versions)
      • Logical backups of MariaDB (10/11/all versions)
      • Physical backups by Xtrabackup (2.4/8.0) of MySQL/Percona (5.7/8.0/all versions)
      • Physical backups by MariaDB-backup of MariaDB (10/11/all versions)
      • Logical backups of PostgreSQL (9/10/11/12/13/14/15/16/all versions)
      • Physical backups by Basebackups of PostgreSQL (9/10/11/12/13/14/15/16/all versions)
      • Backups of MongoDB (4.0/4.2/4.4/5.0/6.0/7.0/all versions)
      • Backups of Redis (all versions)
    • Support of user-defined scripts that extend functionality
  • Upload and manage backups to the remote storage:
    • S3 (Simple Storage Service that provides object storage through a web interface. Supported by clouds e.g. AWS, GCP)
    • SSH (SFTP)
    • FTP
    • CIFS (SMB)
    • NFS
    • WebDAV
  • Notifications via email and webhooks about events of the backup process;
  • Collect, export, and save metrics in Prometheus-compatible format;
  • Limiting resource consumption:
    • CPU usage
    • disk rate
    • remote storage