From a428d3bc9ea5d383af759b0e1561a7ff6ec4dabd Mon Sep 17 00:00:00 2001 From: gospodar Date: Sun, 12 Feb 2023 14:28:20 +0100 Subject: [PATCH] Docs --- README.MD | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.MD b/README.MD index 02abaac..abe0087 100644 --- a/README.MD +++ b/README.MD @@ -1,13 +1,20 @@ Backify 🗃️ =========== -A powerful and automated bash script for backing up all kinds of Linux data, archiving it and pushing it to a remote host. - What is Backify? 👾 ------------------- Backify is a shell script that helps you automate the backup process of all kinds of data from Linux systems. It differs from other backup scripts because it gives you the flexibility to choose what you want to save, ranging from system logs to containers. The script was tailored to meet personal needs as there was no complete solution for the specific use case. +Prerequisites 👷 +------------------- + +- The script must be executed as root. + +- A configuration file named `backup.cfg` must exist in the same directory as the script. + +- The system must be either a Red Hat-based or an Ubuntu-based distribution. + Configuration 🧙‍♂️ -------------------