/polynimbus-backup

Polynimbus Backup maintains local copies of all cloud object storage buckets (AWS S3 for now).

Primary LanguageShellMIT LicenseMIT

Overview

Polynimbus Backup is a subproject of Polynimbus, multi-cloud infrastructure inventory and management tool. Backup subproject is a simple solution, that maintains a local copies of all cloud storage objects (in AWS S3, Azure Storage Shares, Backblaze B2 and Linode Object Storage), using configuration profiles generated by core Polynimbus.

Separation between core Polynimbus and Polynimbus Backup is designed to allow installing core Polynimbus on your core server, with highly restricted access, where the machine itself can be very small - while Polynimbus Backup needs a lot of RAM and disk space.

See Polynimbus documentation page: https://github.com/polynimbus/polynimbus

Installation

Polynimbus Backup has to be installed exactly into /opt/polynimbus-backup directory:

git clone https://github.com/polynimbus/polynimbus-backup /opt/polynimbus-backup
/opt/polynimbus-backup/install.sh

Required system packages

  • cifs-utils
  • keyutils
  • rsync
  • s3cmd
  • kernel 4.11 or higher (previous versions don't support SMB3 protocol)

How to contribute

We are welcome to contributions of any kind: bug fixes, added code comments, support for new operating system versions, cloud platforms etc.

If you want to contribute:

  • fork this repository and clone it to your machine
  • create a feature branch and do the change inside it
  • push your feature branch to github and create a pull request

License

Author: Tomasz Klim (opensource@tomaszklim.pl)
Copyright: Copyright 2019-2021 Tomasz Klim
License: MIT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.