nixyslab/nxs-backup repository overview

⁠Quick reference

• Maintained by:
  Nixys LLC⁠

• Where to get news:
  the @nxs_backup⁠, nxs-backup.io⁠

• Where to get help:
  the @nxs_backup_chat⁠, Maintainer Telegram⁠, or GitHub Issues⁠

• Where to file issues:
  https://github.com/nixys/nxs-backup/issues⁠

⁠Supported tags and respective Dockerfile links

• 3.11.0, 3.11, 3, latest, 3.11.0-debian, 3.11-debian, 3-debian, debian⁠
• 3.11.0-alpine, 3.11-alpine, 3-alpine, apline⁠

⁠What is nxs-backup?

nxs-backup is a tool for creating and delivery backus, rotating it locally and on remote storages.

⁠How to use this image

There are two ways described below to install and use the nxs-backup with your infrastructure.

First you need to clone the repo⁠ and go to .deploy/docker-compose or .deploy/kubernetes directory in accordance to the way you choose to install:

git clone [email protected]:nixys/nxs-backup.git

Modify the nxs-backup.conf or helm values according to your backup issues.

⁠Docker-compose

Do the following steps:

• Go to docker compose directory

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

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

  docker compose up -d --pull
  

  Copy

⁠Kubernetes

Do the following steps:

• Go to kubernetes directory

  cd nxs-backup/.deploy/kubernetes/
  

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

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

  Copy
• 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
  

  Copy
  where $NAMESPACE_SERVICE_NAME is the namespace in which to back up your data

⁠License

nxs-backup⁠ is open source and released under the terms of the Apache-2.0 license⁠.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.