nxs-backup

[![Telegram News][tg-news-badge]][tg-news-url] [![Telegram Chat][tg-chat-badge]][tg-chat-url]

!nxs-backup

nxs-backup is a tool for creating and delivery backups, rotating it locally and on remote storages, compatible with GNU/Linux distributions.

Introduction

Features

• Full data backup

• Upload and manage backups to the remote storages:

• Fine-tune the database backup process with additional options for optimization purposes
• Notifications about events of the backup process via email and webhooks
• Collect, export, and save metrics in Prometheus-compatible format
• Limiting resource consumption:

Who can use the tool?

• System Administrators
• DevOps Engineers
• Developers
• Anybody who need to do regular backups

Quickstart

• Clone the repo

git clone https://github.com/nixys/nxs-backup.git

On-premise (bare-metal or virtual machine)

• Go to on-premise directory

cd nxs-backup/.deploy/on-premise/

• Install nxs-backup, just download and unpack archive for your CPU architecture.

curl -L https://github.com/nixys/nxs-backup/releases/latest/download/nxs-backup-amd64.tar.gz -o /tmp/nxs-backup.tar.gz
  tar xf /tmp/nxs-backup.tar.gz -C /tmp
  sudo mv /tmp/nxs-backup /usr/sbin/nxs-backup
  sudo chown root:root /usr/sbin/nxs-backup

[!NOTE]

nxs-backup is built for the following processor architectures: amd64 (x86_64), arm (armv8), arm64 (aarch64).

If you need specific version of nxs-backup, or different architecture, you can find it on release page.

• Check that installation successful:

sudo nxs-backup --version

• Generate configuration files like described here or update

• For starting nxs-backup process run:

sudo nxs-backup start

Docker-compose

• Go to docker compose directory

cd nxs-backup/.deploy/docker-compose/

• Update provided nxs-backup.conf file with your parameters (see docs for details)
• Launch the nxs-backup with command:

docker compose up -d --pull

Kubernetes

• Go to kubernetes directory

cd nxs-backup/.deploy/kubernetes/

• Install nxs-universal-chart (Helm 3 is required):

helm repo add nixys https://registry.nixys.io/chartrepo/public

• Find examples of helm values here
• Fill up your values.yaml with correct nxs-backup configs
• Launch nxs-backup with command:

helm -n $NAMESPACE_SERVICE_NAME install nxs-backup nixys/nxs-universal-chart -f values.yaml

Documentation

For detailed information on using the tool please visit nxs-backup.io.

Roadmap

Following features are already in backlog for our development team and will be released soon:

• Encrypting of backups
• Restore backups by nxs-backup
• API for remote management and metrics monitoring
• Web interface for management
• Proprietary startup scheduler
• New backup types (Clickhouse, Elastic, lvm, etc.)
• Programmatic implementation of backup creation instead of calling external utilities

Feedback

For support and feedback please contact me:

• Telegram: @r_andreev
• Email: [email protected]

• Telegram community (news): @nxs_backup
• Telegram community (chat): @nxs_backup_chat

License

nxs-backup is released under the Apache-2.0 license.

[tg-news-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fnxs_backup [tg-chat-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fnxs_backup_chat [tg-news-url]: https://t.me/nxs_backup [tg-chat-url]: https://t.me/nxs_backup_chat