Skip to content

datenknoten/restic-orchestrator

Repository files navigation

restic orchestrator

With restic you can do fine backups on individual hosts. With restic orchestrator you can do that on multiple hosts.

Greenkeeper badge Maintainability Test Coverage Build Status

Install

I'm building releases for linux amd64 with nexe, which you can find the release section.

You can also clone this repo and run the orchestrator from your shell:

$ git clone https://github.com/datenknoten/restic-orchestrator
$ cd restic-orchestrator
$ npm install
$ npm start

You need at least node 8.

Usage

You need to put a config file in one of these directories:

OS Path
Linux $XDG_DATA_HOME/restic-orchestrator/config.json or $HOME/.local/share/restic-orchestrator/config.json
Windows %APPDATA%/datenknoten/restic-orchestrator/config.json
Mac OSX $HOME/Library/Application Support/restic-orchestrator/config.json

Then run restic-orchestrator everytime you want to do a backup.

Development

If you want to write code for this project, you are welcome! Please make sure to write tests for your code, respect the linter and make sure that the typescript compiler can comile your code into javascript:

$ npm run lint
$ npm run test
$ npm run compile

This package uses husky to execute git hooks, to make you produce great code more easy.