mirror of
https://github.com/YunoHost-Apps/borg_ynh.git
synced 2024-09-03 18:16:05 +02:00
58 lines
3 KiB
Markdown
58 lines
3 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Borg Backup for YunoHost
|
|
|
|
[](https://ci-apps.yunohost.org/ci/apps/borg/)  
|
|
|
|
[](https://install-app.yunohost.org/?app=borg)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Borg Backup quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
A [Borg](https://borgbackup.readthedocs.io/en/stable/index.html#what-is-borgbackup) integration to backup your YunoHost server to another remote server (e.g. one of your friends).
|
|
|
|
This app is the "client" part, meant to be installed on the server to be backed up. It works in combination with the [borg server app](https://apps.yunohost.org/app/borgserver) installed on a diffent machine.
|
|
|
|
### Features
|
|
|
|
- Backup on a remote machine, in combination with the [borg server app](https://apps.yunohost.org/app/borgserver)
|
|
- ... or on a [commercial borg service](https://www.borgbackup.org/support/commercial.html)
|
|
- Backups are encrypted (the remote server can't read the content) and deduplicated (optimize space)
|
|
- Backups are ran automatically, you can choose when and at which frequency
|
|
- You can choose what apps are backed up
|
|
- Receive email alerts if the backup fails (the [borg server app](https://apps.yunohost.org/app/borgserver) also checks that new content arrives and send an email to your friend otherwise)
|
|
|
|
### Install procedure
|
|
|
|
Maybe counter-intuitively, you should *first* install this app (`borg_ynh`) and *then* (`borgserver_ynh`) on the other machine. In fact, at the end of the install of `borg_ynh`, you will be provided with the info, in particular the SSH public key, to be used to setup `borgserver_ynh` on the other machine.
|
|
|
|
|
|
**Shipped version:** 1.4.0~ynh1
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://www.borgbackup.org>
|
|
- Official admin documentation: <https://borgbackup.readthedocs.io>
|
|
- Upstream app code repository: <https://github.com/borgbackup/borg>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/borg>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/borg_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/borg_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/borg_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade borg -u https://github.com/YunoHost-Apps/borg_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|