X-Git-Url: https://git.p6c8.net/nextcloud-backup-restore.git/blobdiff_plain/a255984af351e3ca0d5afb521d9c0480a46011f1..22bc4b2e4bbd70be86adf0bfb244b09e879478a4:/README.md

diff --git a/README.md b/README.md
index 385102f..ee669f3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# Nextcloud-Backup-Restore
\ No newline at end of file
+# Nextcloud-Backup-Restore
+
+This repository contains two bash scripts for backup/restore of [Nextcloud](https://nextcloud.com/).
+
+It is based on a Nextcloud installation using nginx and MariaDB (see the (German) tutorial [Nextcloud auf Ubuntu Server mit nginx, MariaDB, PHP, Let’s Encrypt, Redis und Fail2ban](https://decatec.de/home-server/nextcloud-auf-ubuntu-server-mit-nginx-mariadb-php-lets-encrypt-redis-und-fail2ban/)).
+
+## General information
+
+For a complete backup of any Nextcloud instance, you'll have to backup three items:
+- The Nextcloud file directory (usually */var/www/nextcloud*)
+- The data directory of Nextcloud (it's recommended to locate this not under the web root, so e.g. */var/nextcloud_data*)
+- The Nextcloud database
+
+The scripts take care of these three items to backup automatically.
+
+**Important:**
+
+- After cloning or downloading the repository, you'll have to edit the scripts so that they represent your current Nextcloud installation (directories, users, etc.).
+- The scripts assume that Nextcloud's data directory is *not* a subdirectory of the Nextcloud installation (file directory). The general recommendation is that the data directory should not be located somewhere in the web folder of your webserver (usually */var/www/*), but in a different folder (e.g. */var/nextcloud_data*). However, if your data directory is located under the Nextcloud file directory, you'll have to change the scripts so that the data directory is not part of the backup/restore (otherwise, it would be copied twice).
+- If you do not want to save the database password in the scripts, remove the variable *dbPassword* and call *mysql* with the *-p* parameter (without password). When calling the scripts manually, you'll be asked for the database password. 
+
+## Backup
+
+In oder to create a backup, simplly call the script *NextcloudBackup.sh* on your Nextcloud machine.
+This will create a direcotry with the current time stamp in your main backup directory (you already edited the script so that it fits yout Nextcloud installation, haven't you): As an example, this would be */mnt/Share/NextcloudBackups/20170910_132703*.
+
+## Restore
+
+For restore, just call *NextcloudRestore.sh*. This script expects one parameter which is the name of the backup to be restored. In our example, this would be *20170910_132703* (the time stamp of the backup created before). So the full command for a restore would be *./NextcloudRestore.sh 20170910_132703*.
\ No newline at end of file