https://github.com/kwiesmueller/zup

Backup and restore tool sending ZFS snapshots via ssh onto encrypted zpools
https://github.com/kwiesmueller/zup

Last synced: 10 days ago
JSON representation

Backup and restore tool sending ZFS snapshots via ssh onto encrypted zpools

• Host: GitHub
• URL: https://github.com/kwiesmueller/zup
• Owner: kwiesmueller
• License: mit
• Created: 2018-05-16T00:45:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-05-16T01:24:07.000Z (over 6 years ago)
• Last Synced: 2024-10-28T19:50:55.549Z (about 2 months ago)
• Language: Makefile
• Size: 589 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zup - Backup and restore using zfs, ssh, encryption and golang

[![Go Report Card](https://goreportcard.com/badge/github.com/kwiesmueller/zup)](https://goreportcard.com/report/github.com/kwiesmueller/zup)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/513590eff4e54095a25b66bf65bd1323)](https://www.codacy.com/app/kwiesmueller/zup?utm_source=github.com&utm_medium=referral&utm_content=kwiesmueller/zup&utm_campaign=Badge_Grade)

[![Build Status](https://travis-ci.org/kwiesmueller/zup.svg?branch=master)](https://travis-ci.org/kwiesmueller/zup)

[![Docker Repository on Quay](https://quay.io/repository/kwiesmueller/zup/status "Docker Repository on Quay")](https://quay.io/repository/kwiesmueller/zup)

Zup is used to create regular snapshots using zfs and storing them on an encrypted drive on a remote server.

## Process

Zup is doing backups in the following way:

1. A ZFS snapshot is being made

2. Zup is powering up the remote backup server using the respective api (if the server is down)

3. A SSH connection is being opened

4. The remote backup disk is being decrypted using a key stored only on the client side (piping it into decrypt) and the zpool on it get's mounted

5. The latest snapshot(s) is being transfered to the remote pool using zfs send/receive through ssh

6. Both the zpool and the decrypted drive get unmounted

7. Zup is shutting down the remote server using the respective api

## Dependencies

All dependencies inside this project are being managed by [dep](https://github.com/golang/dep) and are checked in.

After pulling the repository, it should not be required to do any further preparations aside from `make deps` to prepare the dev tools (once).

If new dependencies get added while coding, make sure to add them using `dep ensure --add "importpath"` and to check them into git.

We recommend adding your vendor changes in a separate commit to make reviewing your changes easier and faster.

## Contributing

Feedback and contributions are highly welcome. Feel free to file issues or pull requests.

## Attributions

* [Kolide for providing `kit`](https://github.com/kolide/kit)