Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
simonsan authored Jan 7, 2024
1 parent 5ff45b9 commit f7d5bab
Showing 1 changed file with 37 additions and 5 deletions.
42 changes: 37 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
# Rustic
<p align="center">
<a href="https://rustic.cli.rs/rustic-helm/"><img src="https://raw.githubusercontent.com/rustic-rs/assets/main/logos/readme_header_helm.png" height="400" /></a>
</p>
<p align="center"><b>Helm charts for rustic - a solution for fast, encrypted, and deduplicated backups</b></p>

[Rustic](https://rustic.cli.rs/) is a backup tool that provides fast, encrypted and deduplicated backups.
## About

It reads and writes the [restic](https://github.com/restic/restic) repo format described in the [design document](https://github.com/restic/restic/blob/master/doc/design.rst) and can be used as a restic replacement in most cases.
[rustic](https://rustic.cli.rs/) is a backup tool that provides fast, encrypted and deduplicated backups. This chart installs `rustic backup` as [Kubernetes CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), which will run a [Kubernetes Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) periodically on a given schedule. It can optionally initialize a new repository by creating a single Job running `rustic init`.

## Contact

You can ask questions in the
[Discussions](https://github.com/rustic-rs/rustic/discussions) or have a look at
the [FAQ](https://rustic.cli.rs/docs/FAQ.html).

| Contact | Where? |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| Issue Tracker | [GitHub Issues](https://github.com/rustic-rs/rustic-helm/issues/choose) |
| Discord | [![Discord](https://dcbadge.vercel.app/api/server/WRUWENZnzQ?style=flat-square)](https://discord.gg/WRUWENZnzQ) |
| Discussions | [GitHub Discussions](https://github.com/rustic-rs/rustic/discussions) |

## Introduction

This chart installs `rustic backup` as [Kubernetes CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), which will run a [Kubernetes Job](https://kubernetes.io/docs/concepts/workloads/controllers/job/) periodically on a given schedule. It can optionally initialize a new repository by creating a single Job running `rustic init`.

## Installing

Expand Down Expand Up @@ -86,3 +99,22 @@ s3:
storage_class: ONEZONE_IA # Replace with your provider's hot storage class
bucket: <myHotBucket>
```
## Contributing
Found a bug?
- [Open an issue!](https://github.com/rustic-rs/rustic-helm/issues/choose)
Got an idea for an improvement? Don't keep it to yourself!
- [Contribute fixes](https://github.com/rustic-rs/rustic-helm/contribute) or new
features via a pull requests!
Please make sure, that you read the
[contribution guide](https://rustic.cli.rs/docs/contributing-to-rustic.html).
## License
Licensed under [Apache License, Version 2.0](./LICENSE-APACHE).

0 comments on commit f7d5bab

Please sign in to comment.