2022-02-22 13:03:09 +01:00
<!--
2024-04-10 23:29:43 +02:00
N.B.: This README was automatically generated by < https: / / github . com / YunoHost / apps / tree / master / tools / readme_generator >
2022-02-22 13:03:09 +01:00
It shall NOT be edited by hand.
-->
2021-01-11 00:36:16 +01:00
# Borg Server for YunoHost
2018-06-14 02:13:59 +02:00
2024-08-12 13:08:20 +02:00
[![Integration level ](https://dash.yunohost.org/integration/borgserver.svg )](https://ci-apps.yunohost.org/ci/apps/borgserver/) ![Working status ](https://ci-apps.yunohost.org/ci/badges/borgserver.status.svg ) ![Maintenance status ](https://ci-apps.yunohost.org/ci/badges/borgserver.maintain.svg )
2023-10-25 21:45:39 +02:00
2021-01-11 00:36:16 +01:00
[![Install Borg Server with YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=borgserver)
2024-04-10 23:29:43 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2022-02-22 13:03:09 +01:00
2024-04-10 23:29:43 +02:00
> *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.*
2021-01-11 00:36:16 +01:00
## Overview
2024-05-03 17:13:02 +02:00
Setup a storage space to be used for backup using Borg
2021-01-11 00:36:16 +01:00
2024-05-03 17:13:02 +02:00
This app is the "server" part, meant to be installed on the machine providing the backup storage. It is designed to work in combination with the [borg 'client' app ](https://apps.yunohost.org/app/borg ) installed on a diffent machine.
2021-01-11 00:36:16 +01:00
2024-08-20 13:36:22 +02:00
**Shipped version:** 1.2.8~ynh5
2022-02-22 13:03:09 +01:00
## Documentation and resources
2021-01-11 00:36:16 +01:00
2024-04-10 23:29:43 +02:00
- 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 Store: < https: // apps . yunohost . org / app / borgserver >
- Report a bug: < https: // github . com / YunoHost-Apps / borgserver_ynh / issues >
2021-01-11 00:36:16 +01:00
## Developer info
2024-04-10 23:29:43 +02:00
Please send your pull request to the [`testing` branch ](https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing ).
2021-01-11 00:36:16 +01:00
2024-04-10 23:29:43 +02:00
To try the `testing` branch, please proceed like that:
2022-10-27 04:21:35 +02:00
2024-04-10 23:29:43 +02:00
```bash
2021-01-11 00:36:16 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing --debug
or
sudo yunohost app upgrade borgserver -u https://github.com/YunoHost-Apps/borgserver_ynh/tree/testing --debug
```
2022-02-22 13:03:09 +01:00
2022-10-27 04:21:35 +02:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >