In the context of self-hosting, backups are an important element to compensate for unexpected events (fire, database corruption, loss of access to the server, compromised server...). The backup policy to implement depends on the importance of the services and data you manage. For example, backing up a test server will be of little interest, while you will want to be very careful if you are managing critical data for an association or a company - and in such cases, you will want to store the backups in a different location or locations.
YunoHost comes with a backup system, that allows to backup (and restore) system configurations and data (e.g. mails) and apps if they support it.
You can manage backups either from the command line (
yunohost backup --help) or from the web administration (in the Backups section) though some features are not yet available in the webadmin.
The current default method consists in creating a
.tar archive containing all relevant files.
You can easily create backup archives from the webadmin by going in
Backups > Local storage and clicking on
New backup. You will then be asked to select which configuration, data and apps you want to backup.
You can create a new backup archive with the command line. Here are a few simple example of commands and their corresponding behavior:
Backing up everything (all system parts and apps):
yunohost backup create
Backing up only apps
yunohost backup create --apps
Backing up only two apps (wordpress and shaarli)
yunohost backup create --apps wordpress shaarli
Backing up only mails
yunohost backup create --system data_mail
Backing up mails and wordpress
yunohost backup create --system data_mail --apps wordpress
For more informations and options about backup creation, consult
yunohost backup create --help. You can also list system parts that can be backuped with
yunohost hook list backup.
After creating backups, it is possible to list and inspect them using the corresponding views in the web administration interface. A button offers to download the archive. If the archive is larger than 3GB, it may be better to proceed via SFTP.
Backup > Local Archives > <Archive name> > Download
Currently, the most accessible way to download big archives is to use the program FileZilla as explained in this page.
By default, backups are stored in
yunohost backup list and
yunohost backup info <archive_name> commands provide information about the names and sizes of backups.
It is possible to use
scp (a program based on
) to copy files between two machines via the command line. So, from a GNU/Linux machine, you can use the following command to download an archive:
scp email@example.com:/home/yunohost.backup/archives/<archive_name>.tar ./
Don't forget to store your backup in a different place than your server.
If you want, you can connect an external disk to your server so that the archives arrive directly on it. See this guide for Add an external storage to your server
You should regularly test your backups by at least listing the contents of the archives and checking the weight of the associated data. It is best to practice restoring regularly.
# List the files tar -tvf /home/yunohost.backup/archives/ARCHIVE.tar | less # List database exports tar -tvf /home/yunohost.backup/archives/ARCHIVE.tar | grep "(db|dump)`.sql" # Check the weight ls -lh /home/yunohost.backup/archives/ARCHIVE.tar
SPOILER: The larger your data volume and the more applications you have, the more complex your recovery will be.
Backup > Local storage and select your archive. You can then select which items you want to restore, then click on 'Restore'.
From the command line, you can run
yunohost backup list to get the available archive names. They are basically their file name without extension.
You can then run
yunohost backup restore <archivename> (hence without its
.tar extension) to restore an archive. As for
yunohost backup create, this will restore everything in the archive by default. If you want to restore only specific items, you can use for instance
yunohost backup restore <archivename> --apps wordpress which will restore only the wordpress app.
In the case of a complete restoration, it is possible to restore instead of launching the initial configuration.
To restore an app, the domain on which it was installed should already be configured (or you need to restore the corresponding system configuration). You also cannot restore an app which is already installed... which means that to restore an old version of an app, you must first uninstall it.
In many cases, the archive is not on the server on which you want to restore it. So it has to be uploaded, which depending on its weight can take more or less time.
Currently, the most accessible solution for uploading backups is to use the FileZilla program as explained in this page.
By default, backups are to be placed in
You can upload a backup from a machine to your server with :
scp /path/to/your/<archive_name>.tar.gz firstname.lastname@example.org:/home/yunohost.backup/archives/
There are 3 YunoHost applications that offer to extend YunoHost with an automated backup method.
Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to suggest changes.