diff --git a/README.md b/README.md index b189fc2489421d6b8749f056ad836bf038b93b04..d99f88f38c72a60a3c1f4aeebd8a5a0de7e4e87f 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,17 @@ It comes with a built-in mechanism to check and delete old backups. ## Installing / Getting started +### Requirements + +#### OS + +This project is developed and tested under Debian 11 Bullseye. + +#### JSON Parser + +The script is loading its needed configuration from a JSON file. Therefor a JSON parser is needed. +In this project, the parser 'jq' is being used. It can be installed via the default Debian repository. + Clone the repository and execute the installation script. ```shell diff --git a/install.sh b/install.sh index a4636fcce2f972811f9668899b874d5e7c71593f..7a4bac6de122e789c08d81cfbb7fc4b1f52ff76a 100644 --- a/install.sh +++ b/install.sh @@ -10,6 +10,12 @@ else cd /opt/sql-backup fi +# Check if jqis installed +if [ -z $(which apt) ]; then + echo "ERROR: JSON parser 'jq' not found, but necessary. Make sure that 'jq' is installed correctly." + exit 1 +fi + # Update repository bash update.sh