Readme

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

diff --git a/README.md b/README.md
index 4e2002d051f9e6c6d7c1f60c5e3781f890ca87f9..3373b0a96f5c6017dd48d67e60d35f644da8b89e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+![release](https://img.shields.io/badge/dynamic/json.svg?label=release&url=https://codeberg.org/api/v1/repos/DecaTec/Nextcloud-Backup-Restore/releases&query=$[0].tag_name)
+

 # Nextcloud-Backup-Restore
 
 This repository contains two bash scripts for backup/restore of [Nextcloud](https://nextcloud.com/).
 # Nextcloud-Backup-Restore
 
 This repository contains two bash scripts for backup/restore of [Nextcloud](https://nextcloud.com/).


@@ -16,9 +18,9 @@ The scripts take care of these items to backup automatically.
 
 ## Requirements
 
 
 ## Requirements
 

-- *pigz* (https://zlib.net/pigz/) when using backup compression. If not available, you can use another compression algorithm (e.g. gzip)
+- *pigz* (https://zlib.net/pigz/) when using backup compression. If not installed already, it can be installed with `apt install pigz` (Debian/Ubuntu). If not available, you can use another compression algorithm (e.g. gzip)

 
 

-**Important:**
+## Important notes about using the scripts

 
 - After cloning or downloading the repository, you'll have to edit the scripts so that they represent your current Nextcloud installation (directories, users, etc.). All values which need to be customized are marked with *TODO* in the script's comments.
 - 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*). For more information, see [here](https://docs.nextcloud.com/server/latest/admin_manual/installation/installation_wizard.html#data-directory-location-label).
 
 - After cloning or downloading the repository, you'll have to edit the scripts so that they represent your current Nextcloud installation (directories, users, etc.). All values which need to be customized are marked with *TODO* in the script's comments.
 - 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*). For more information, see [here](https://docs.nextcloud.com/server/latest/admin_manual/installation/installation_wizard.html#data-directory-location-label).