Added some general information

[nextcloud-backup-restore.git] / README.md

diff --git a/README.md b/README.md
index 75eae70259e2369972c7a86080a90f128929de7f..5d6624fdc9ea69cede85942a63b1c3a052d37034 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,12 +4,6 @@ This repository contains two bash scripts for backup/restore of [Nextcloud](http
 
 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/)).
 
-## Usage
-
-**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.)
-
 ## General information
 
 For a complete backup of any Nextcloud instance, you'll have to backup three items:
@@ -19,11 +13,17 @@ For a complete backup of any Nextcloud instance, you'll have to backup three ite
 
 The scripts take care of these three items to backup automatically.
 
-### Backup
+**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*).
+- 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
+## 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
+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*.