From 61ec2ee524c1488d583079d095101380cb6e1995 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Tue, 22 Feb 2022 12:50:55 +0100 Subject: [PATCH 1/3] Add doc/DESCRIPTION.md to trigger auto-README system --- doc/DESCRIPTION.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 doc/DESCRIPTION.md diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..b6fee80 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,3 @@ +Offer backup storage to a friend. + +The main goal of Borg is to provide an efficient and secure way to backup data. The data deduplication technique used makes Borg suitable for daily backups since only changes are stored. The authenticated encryption technique makes it suitable for backups to not fully trusted targets. From 7996e005009da8aeb1457934f70f40c71c897976 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Tue, 22 Feb 2022 13:02:53 +0100 Subject: [PATCH 2/3] Add upstream key in manifest --- manifest.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/manifest.json b/manifest.json index 00f0bce..710c48b 100644 --- a/manifest.json +++ b/manifest.json @@ -6,6 +6,12 @@ "en": "Offer backup storage to a friend.", "fr": "Offrez un espace de stockage à un⋅e ami⋅e." }, + "upstream": { + "license": "BSD-3-Clause", + "website": "https://www.borgbackup.org/", + "admindoc": "https://borgbackup.readthedocs.io/en/stable/", + "code": "https://github.com/borgbackup/borg" + }, "version": "1.1.16~ynh9", "url": "https://borgbackup.readthedocs.io", "license": "BSD-3-Clause", From 3efeed0e87094334b886daac2c4d953eee8005b7 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Tue, 22 Feb 2022 12:03:09 +0000 Subject: [PATCH 3/3] Auto-update README --- README.md | 50 +++++++++++++++++++------------------------------- README_fr.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 31 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index c19f68a..489e494 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,36 @@ + + # Borg Server for YunoHost [![Integration level](https://dash.yunohost.org/integration/borgserver.svg)](https://dash.yunohost.org/appci/app/borgserver) ![](https://ci-apps.yunohost.org/ci/badges/borgserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/borgserver.maintain.svg) [![Install Borg Server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=borgserver) -> *This package allows you to install Borg Server quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Borg Server 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 + Offer backup storage to a friend. + The main goal of Borg is to provide an efficient and secure way to backup data. The data deduplication technique used makes Borg suitable for daily backups since only changes are stored. The authenticated encryption technique makes it suitable for backups to not fully trusted targets. -**Shipped version:** 1.1.16 -## Documentation +**Shipped version:** 1.1.16~ynh9 - * Official documentation: https://borgbackup.readthedocs.io/en/stable/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. -## YunoHost specific features -#### Multi-user support +## Documentation and resources - * Are LDAP and HTTP auth supported? - * Can the app be used by multiple users? - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/borgserver%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/borgserver/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/borgserver%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/borgserver/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/borgserver_ynh/issues - * App website: https://www.borgbackup.org/ - * Upstream app repository: https://github.com/borgbackup/borg - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://www.borgbackup.org/ +* Official admin documentation: https://borgbackup.readthedocs.io/en/stable/ +* Upstream app code repository: https://github.com/borgbackup/borg +* YunoHost documentation for this app: https://yunohost.org/app_borgserver +* Report a bug: https://github.com/YunoHost-Apps/borgserver_ynh/issues ## Developer info @@ -56,3 +42,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/borgserver_ynh/tree/t or sudo yunohost app upgrade borgserver -u https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..89269cd --- /dev/null +++ b/README_fr.md @@ -0,0 +1,42 @@ +# Borg Server pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/borgserver.svg)](https://dash.yunohost.org/appci/app/borgserver) ![](https://ci-apps.yunohost.org/ci/badges/borgserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/borgserver.maintain.svg) +[![Installer Borg Server avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=borgserver) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Borg Server rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +Offer backup storage to a friend. + +The main goal of Borg is to provide an efficient and secure way to backup data. The data deduplication technique used makes Borg suitable for daily backups since only changes are stored. The authenticated encryption technique makes it suitable for backups to not fully trusted targets. + + +**Version incluse :** 1.1.16~ynh9 + + + +## Documentations et ressources + +* Site officiel de l'app : https://www.borgbackup.org/ +* Documentation officielle de l'admin : https://borgbackup.readthedocs.io/en/stable/ +* Dépôt de code officiel de l'app : https://github.com/borgbackup/borg +* Documentation YunoHost pour cette app : https://yunohost.org/app_borgserver +* Signaler un bug : https://github.com/YunoHost-Apps/borgserver_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing --debug +ou +sudo yunohost app upgrade borgserver -u https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file