https://github.com/prikhi/hs-backup

Robust Backup Server for Resumable, Archived Network Backups
https://github.com/prikhi/hs-backup

backup backup-tool cli haskell rsync

Last synced: 21 days ago
JSON representation

Robust Backup Server for Resumable, Archived Network Backups

• Host: GitHub
• URL: https://github.com/prikhi/hs-backup
• Owner: prikhi
• License: gpl-3.0
• Created: 2019-10-01T03:41:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-10T04:02:38.000Z (almost 5 years ago)
• Last Synced: 2024-11-16T08:36:10.229Z (3 months ago)
• Topics: backup, backup-tool, cli, haskell, rsync
• Language: Haskell
• Homepage:
• Size: 70.3 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hs-backup

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

hs-backup is a service that backups up remote folders using `rsync`.

* Configured with YAML.

* Safely handles program restarts, system reboots, and network interruptions -

  retries a backup until it has completed.

* Skips enqueuing new backups if syncing takes longer than the backup period.

* Uses the link destination `rsync` flag to compare files from previous

  backups, saving bandwidth & disk space.

* Allows limiting of bandwidth usage to prevent network congestion during

  backup process.

* Allows ignoring files & directories during backup process using rsync's

  filter patterns.

* Uses hardlinks to archive backups for longer periods of time, turning hourly

  backups into daily, monthly, & yearly backups.

* Automatically culls old backups.

## Build / Install

You can build & install the service using [stack][stack]:

```

stack install

```

This will put the `hs-backup` executable in your `~/.local/share/` folder.

Developers working on `hs-backup` probably want to start a file-watching build

server:

```

stack build --pedantic --file-watch --fast

```

## Configuration

By default, `hs-backup` will attempt to read a configuration file from

`/etc/hs-backup.yaml`. You can use the `--config-file` or `-c` flag to pass a

custom configuration file to the server.

See the `example-hs-backup.yaml` file in this repository for an example of a

configuration file as well as documentation on each field.

## TODO

While the server is completely usable, there are some improvements we'd like to

implement:

* More configuration options:

    * Backup folder format strings

    * BackupRate folder names

    * Maximum backups to retain

    * Delay time for checking for backups

    * Delay time for retrying a backup

## License

GPL-3.0+

[stack]: https://docs.haskellstack.org/en/stable/README/