Git Product home page Git Product logo

backuper's Introduction

Backuper

All Contributors

Download your backups automatically.

Installation

You need python 3.6 with pip. Install it on ubuntu with: sudo apt install python3.7 python3-pip

Configuration

Environment Variables

# The path of the config file
# Default: config.json
BACKUPER_CONFIG_PATH=/the/path/of/the/config/file.json
# The datetime format of the filename, see here: https://www.programiz.com/python-programming/datetime/strftime
# WARNING: The datetime format must not contain '_' otherwise the app would crash.
BACKUPER_FILE_DATETIME_FORMAT=%d-%m-%Y-%H-%M-%S
# The level of the logging service (python logging module).
# The level can be: CRITICAL, FATAL, ERROR, WARN, WARNING, INFO or DEBUG
BACKUPER_LOGGING_LEVEL=INFO

The config file should have the json format.

Config file

{
  "receiver": {
    "file": "https://the.url.of.the/downloading_file.bin",
    "file_hash": "https://the.url.of.the/downloading_file.bin.sha256sum",
    "hash_algorithm": "sha256",
    "auth": {
      "http_auth": {
        "username": "the username",
        "password": "the password"
      },
      "client_certificate": {
        "cert": "the/path/of/the/client/certificate/cert.pem",
        "key": "the/path/of/the/client/certificate/privkey.key",
      },
      "get_parameters": {
        
      },
      "headers": {
        
      }
    },
    "ca_file": "the/path/to/the/certificate/authority/certificate.pem"
  },
  "output": {
    "directory": "/the/directory/of/the/backup/files"
  }
}

Please remove all parts of the file, that you are not using, otherwise the application would bring an error. So if you are not using the client_certificate authentication or other things remove it.

Functionality

When you start the app, the app does make a request to the file_hash uri and will compare the hash with the hash of the current backup file. If the hashes are different, the app will download the new backup file (file uri) in the data directory. The filename would have the following syntax: {6-digit-number}_%d-%m-%Y-%H-%M-%S_backup_{real_file_name}.
The file does have the suffix .not.verified. When the download is finished and file hash check is successful the suffix will be removed.

Contributing

You can open a Issue, when you have a problem or an idea. Please describe all things detailed.

When you want to solve your Issue yourself, fork the repository and make the change in your repository. When you checked the functionality of your change you can create a pull request to the master or development branch of this repository.

Contributors โœจ

Thanks goes to these wonderful people (emoji key):


AdriDevelopsThings

๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!

backuper's People

Contributors

adridevelopsthings avatar allcontributors[bot] avatar

Stargazers

 avatar

Watchers

 avatar

backuper's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.