YunoHost-Apps/borg_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/borg_ynh.git synced 2024-07-06 03:06:30 +00:00
Code Issues Actions Activity
An experimental Borg implementation for YunoHost
326 commits 3 branches 0 tags 526 KiB
Shell 100%
Go to file
Kayou c05121ef5d
Merge pull request #162 from YunoHost-Apps/testing 
Testing
2024-07-03 15:49:59 +02:00
.github [autopatch] Update issue and PR templates 2021-05-13 17:45:16 +02:00
conf Update conf/backup_method 2024-07-02 09:15:25 +02:00
doc Create 1.2.8.md 2024-06-19 10:34:18 +02:00
scripts fix config panel 2024-06-28 10:26:42 +02:00
ALL_README.md Auto-update READMEs 2024-05-21 20:33:03 +00:00
config_panel.toml Rework ADMIN.md, misc wording etc 2024-05-03 15:43:33 +02:00
LICENSE Initial commit 2018-06-13 18:03:09 +02:00
manifest.toml Update manifest.toml: bump version 2024-06-25 01:16:28 +02:00
README.md Auto-update READMEs 2024-06-28 08:26:46 +00:00
README_es.md Auto-update READMEs 2024-06-28 08:26:46 +00:00
README_eu.md Auto-update READMEs 2024-06-28 08:26:46 +00:00
README_fr.md Auto-update READMEs 2024-06-28 08:26:46 +00:00
README_gl.md Auto-update READMEs 2024-06-28 08:26:46 +00:00
README_zh_Hans.md Auto-update READMEs 2024-06-28 08:26:46 +00:00
tests.toml fix upgrade args 2024-07-03 10:22:37 +02:00

README.md

Borg Backup for YunoHost

Integration level Working status Maintenance status

Install Borg Backup with YunoHost

Read this README in other languages.

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 to learn how to install it.

Overview

A Borg 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 installed on a diffent machine.

Features

  • Backup on a remote machine, in combination with the borg server app
  • ... or on a commercial borg service
  • 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 backuped
  • Receive email alerts if the backup fails (the borg server app 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.2.8~ynh2

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

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