mirror of
https://github.com/YunoHost-Apps/archivist_ynh.git
synced 2024-09-03 18:15:55 +02:00
60 lines
2.6 KiB
Markdown
60 lines
2.6 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.
|
|
-->
|
|
|
|
# Archivist for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/archivist)  
|
|
|
|
[](https://install-app.yunohost.org/?app=archivist)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Archivist 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
|
|
|
|
Archivist is an automatic backup system for your server.
|
|
It able to makes backups of your YunoHost core and your apps by using the YunoHost backup command.
|
|
It can also makes backups of specified directories.
|
|
Your backups can be send to many other places, local or distant.
|
|
Archivist is automatically launched periodicaly to update your backups and send the modifications to the other places.
|
|
|
|
|
|
|
|
**Shipped version:** 1.3.3~ynh1
|
|
## Disclaimers / important information
|
|
|
|
## Configuration
|
|
|
|
The configuration of archivist can be changed in the file /opt/yunohost/archivist/Backup_list.conf
|
|
Please read the [documentation](https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md) about the configuration of archivist for more informations.
|
|
|
|
## Limitations
|
|
|
|
* Encfs, which be used to encrypt the data, is not fully secured.
|
|
Have a look to the [security audit](https://defuse.ca/audits/encfs.htm) to have more informations.
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://github.com/maniackcrudelis/archivist>
|
|
* Upstream app code repository: <https://github.com/maniackcrudelis/archivist>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_archivist>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/archivist_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/archivist_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade archivist -u https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|