1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/archivist_ynh.git synced 2024-09-03 18:15:55 +02:00

Readme and corrections

This commit is contained in:
Maniack Crudelis 2017-11-03 01:11:50 +01:00
parent a1d53e27d5
commit 2b2793737d
6 changed files with 57 additions and 9 deletions

48
README.md Normal file
View file

@ -0,0 +1,48 @@
# Archivist for YunoHost
[![Integration level](https://dash.yunohost.org/integration/archivist.svg)](https://ci-apps.yunohost.org/jenkins/job/archivist%20%28Community%29/lastBuild/consoleFull)
[![Install ssh chroot directory with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=archivist)
> *This package allow you to install archivist quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy 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:** 0.2
## Screenshots
## 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.
## Documentation
* YunoHost documentation: There no specific documentations, feel free to contribute.
## YunoHost specific features
#### Multi-users support
Not relevant.
#### Supported architectures
* Tested on x86_64
## 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.
## Links
* Report a bug: https://github.com/YunoHost-Apps/archivist_ynh/issues
* archivist website: https://github.com/maniackcrudelis/archivist
* YunoHost website: https://yunohost.org/

View file

@ -1,6 +1,6 @@
SOURCE_URL=https://github.com/maniackcrudelis/archivist/archive/master.zip
SOURCE_SUM=061ad15845602f537aba95f389f785f2
SOURCE_URL=https://github.com/maniackcrudelis/archivist/archive/v0.2.tar.gz
SOURCE_SUM=25cdcd97bcb449e3b649e23a68ace0af
SOURCE_SUM_PRG=md5sum
SOURCE_FORMAT=zip
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=

View file

@ -1 +1 @@
__FREQUENCY__ root __FINALPATH__/archivist.sh | tee -a /var/log/__APP__/__APP__.log 2>&1
__FREQUENCY__ root nice -n10 __FINALPATH__/archivist.sh | tee -a /var/log/__APP__/__APP__.log 2>&1

View file

@ -71,8 +71,8 @@ ynh_setup_source "$final_path"
# CREATE THE BACKUP DIRECTORY
#=================================================
backup_dir="/home/yunohost.app/${app}_backup"
enc_backup_dir="/home/yunohost.app/${app}_encrypted_backup"
backup_dir="/home/yunohost.app/${app}/backup"
enc_backup_dir="/home/yunohost.app/${app}/encrypted_backup"
mkdir -p "$backup_dir"
#=================================================
@ -161,4 +161,4 @@ ynh_use_logrotate
#=================================================
WARNING echo -e "\nTo add recipients or to modify the files or apps to backup,
please have a look to the config file $config_file."
please have a look to the config file $config_file"

View file

@ -50,4 +50,4 @@ ynh_remove_logrotate
ynh_secure_remove "/etc/cron.d/$app"
# Remove the backup directory
ynh_secure_remove "/home/yunohost.app/${app}_backup"
ynh_secure_remove "/home/yunohost.app/${app}/backup"

View file

@ -73,4 +73,4 @@ ynh_restore_file "/etc/cron.d/$app"
# RECREATE DIRECTORIES
#=================================================
mkdir -p "/home/yunohost.app/${app}_backup"
mkdir -p "/home/yunohost.app/${app}/backup"