autorestic/README.md

51 lines
1.8 KiB
Markdown
Raw Normal View History

2020-05-20 19:30:05 +02:00
<p align="center">
<br>
<br>
<br>
2020-11-06 22:42:00 +01:00
<img align="center" src="https://github.com/cupcakearmy/autorestic/raw/master/.github/logo.png" height="50" alt="autorestic logo">
2020-05-20 19:30:31 +02:00
<br>
<br>
2020-05-20 19:30:05 +02:00
<p align="center">
Config driven, easy backup cli for <a href="https://restic.net/">restic</a>.
<br>
2020-11-07 12:47:06 +01:00
<strong><a href="https://autorestic.vercel.app/">»»» Docs & Getting Started »»»</a></strong>
2021-04-28 11:10:36 +02:00
<br><br>
<a target="_blank" href="https://discord.gg/wS7RpYTYd2">
<img src="https://img.shields.io/discord/252403122348097536" alt="discord badge" />
2021-05-06 15:12:11 +02:00
<img src="https://img.shields.io/github/contributors/cupcakearmy/autorestic" alt="contributor badge" />
<img src="https://img.shields.io/github/downloads/cupcakearmy/autorestic/total" alt="downloads badge" />
<img src="https://img.shields.io/github/v/release/cupcakearmy/autorestic" alt="version badge" />
2021-04-28 11:10:36 +02:00
</a>
2020-05-20 19:30:05 +02:00
</p>
</p>
2019-10-26 21:34:02 +02:00
2020-05-20 19:30:05 +02:00
<br>
<br>
2021-04-17 17:50:53 +02:00
### 💭 Why / What?
2019-06-21 12:25:54 +02:00
2021-09-01 00:35:11 +02:00
Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different locations that you want to backup to multiple locations. This utility is aimed at making this easier 🙂.
2020-12-08 23:46:06 +01:00
2021-04-17 17:50:53 +02:00
### 🌈 Features
- YAML config files, no CLI
- Incremental -> Minimal space is used
- Backup locations to multiple backends
- Snapshot policies and pruning
- Fully encrypted
- Pre/After hooks
- Exclude pattern/files
- Cron jobs for automatic backup
- Backup & Restore docker volume
2021-04-17 17:51:23 +02:00
- Generated completions for `[bash|zsh|fish|powershell]`
2021-04-17 17:50:53 +02:00
### ❓ Questions / Support
2020-12-08 23:46:06 +01:00
2021-04-28 11:13:16 +02:00
Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions) or [join on discord](https://discord.gg/wS7RpYTYd2)
2021-04-23 12:31:24 +02:00
## Contributing / Developing
PRs, feature requests, etc. are welcomed :)
Have a look at [the dev docs](./DEVELOPMENT.md)