YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update backup.md

Browse source
This commit is contained in:
ma.azimi@laposte.net 2016-01-26 16:38:11 +01:00 committed by YunoHost
parent 7ae484add3
commit 44af548c89
1 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
backup.md
View file

@ -13,26 +13,32 @@ sudo yunohost backup create
In this version you can backup with cli or with the web admin. The cli way allows you to do more things. The webadmin way is more accessible. In this version you can backup with cli or with the web admin. The cli way allows you to do more things. The webadmin way is more accessible.
## Webadmin way ## Web admin
Basically with the webadmin, you can: Basically with the webadmin, you can:
- backup into /home/yunohost/archives/ - backup into `/home/yunohost/archives/`
- choose to backup one or more things between mail data, home data, configuration and apps - choose to backup one or more data among:
- list your backup - apps data
- emails
- home data
- configuration
- list backups
- see what there is in a backup - see what there is in a backup
- restore selectively a backup - restore selectively a backup
**Caution:** to do a backup, you need to have enough free disk spaces in the destination directory. For example, if you have 20GB in /home/data you need to have enough space to contain this 20GB compressed in a tar.gz. To do the tar.gz, yunohost backup use shallow copy, to avoid to need more spaces to be able to create the tar.gz . **Caution:** to do a backup, you need to have enough free disk spaces in the destination directory. For example, if you have 20GB in `/home/data` you need to have enough space to contain this 20GB compressed in a tar.gz. To do the tar.gz, yunohost backup use shallow copy, to avoid to need more spaces to be able to create the tar.gz.
**Caution:** If you use selective restore, be sure to not create discordant operation. For example, if you restore an app using a domain that have been deleted from YunoHost, you need to read the domain or to restore all configuration files. **Caution:** If you use selective restore, be sure to not create discordant operation. For example, if you restore an app using a domain that have been deleted from YunoHost, you need to read the domain or to restore all configuration files.
We have already planned where we will add some feature like: We have already planned where we will add some feature like:
- backup in an other place - backup in an other memory device
- download/upload a backup - download/upload a backup
- crypt a backup - crypt a backup
Some feature are almost ready in webadmin, but the api is not for the moment.
## CLI way Some feature are almost ready in webadmin, but the API is not for the moment.
## Command line
### Backup ### Backup
You can make a full backup by running this command: You can make a full backup by running this command:
```bash ```bash
@ -67,14 +73,14 @@ archive:
admin@yunohost:~# sudo ls /home/yunohost.backup/archives/ admin@yunohost:~# sudo ls /home/yunohost.backup/archives/
20151126-132533.info.json 20151126-132533.tar.gz 20151126-132533.info.json 20151126-132533.tar.gz
``` ```
By default, it backups in /home/yunohost.backup/archives/, but you can set your own directory with -o option. It could be an usb key or an other mounted filesystem. By default, it backups in `/home/yunohost.backup/archives/`, but you can set your own directory with `-o` option. It could be an usb key or an other mounted filesystem.
If an app has no backup script it warns you. If an app has no backup script it warns you.
As you can see in the answer, there is 2 hooks which backup data (data_home and data_mail). By default, the mysql data aren't saved, because the apps should save themselves their databases. As you can see in the answer, there is 2 hooks which backup data (data_home and data_mail). By default, the mysql data aren't saved, because the apps should save themselves their databases.
**Note:** `yunohost backup` is not able currently to create diff backup. But you can use the -r option to avoid compression and use an other backup tool to make diff backup. **Note:** `yunohost backup` is not able currently to create diff backup. But you can use `-r` option to avoid compression and use an other backup tool to make diff backup.
### Restore ### Restore
To do a restore To do a restore
@ -91,14 +97,11 @@ https://github.com/zamentur/strut_ynh/
There is some helpers to do shadow copy if you have big quantity of data to backup (owncloud, video apps, etc...). There is some helpers to do shadow copy if you have big quantity of data to backup (owncloud, video apps, etc...).
**Note:** During a backup operation, the restore script associated is saved. So in a restore operation, yunohost use the saved restore script and not the most recent script. **Note:** during a backup operation, the restore script associated is saved. So in a restore operation, yunohost use the saved restore script and not the most recent script.
If you want modify a general conf file, you should use hooks to trigger a modification of the conf file after each call of `yunohost regenconf`. If you want modify a general conf file, you should use hooks to trigger a modification of the conf file after each call of `yunohost regenconf`.
You can also use the regeneration configuration system to do index your conf file, and allow your user to be warn if an upgrade of your app has change a config file. You can also use the regeneration configuration system to do index your conf file, and allow your user to be warn if an upgrade of your app has change a config file.
## Annex ## Annex
```bash ```bash
usage: yunohost backup create [-h] [-d DESCRIPTION] [-o OUTPUT_DIRECTORY] usage: yunohost backup create [-h] [-d DESCRIPTION] [-o OUTPUT_DIRECTORY]