Инструкция

README.md

@@ -1,8 +1,8 @@
-▎Описание скрипта резервного копирования
+<h1>▎Описание</h1>
 
 Этот скрипт предназначен для автоматизации процесса резервного копирования файлов и директорий на удаленный FTP-сервер. Он поддерживает отправку уведомлений о статусе резервного копирования через Telegram и Gotify.
 
-▎Функциональные возможности
+<h1>▎Функциональные возможности</h1>
 
 • Чтение конфигурации: Скрипт загружает параметры из файла backup.ini, который содержит настройки для резервного копирования и отправки уведомлений.
 
@@ -14,7 +14,7 @@
 
 • Отправка уведомлений: Возможность отправки уведомлений о статусе резервного копирования через Telegram и Gotify.
 
-▎Установка
+<h1>Ручная установка</h1>
 
 1. Убедитесь, что у вас установлены необходимые утилиты:
 
@@ -22,9 +22,13 @@
    sudo apt-get install tar curl lftp
    ```
 
-2. Создайте файл конфигурации backup.ini с необходимыми параметрами.
+2. Скопируйте файл скрипта .sh и файл конфигурации .ini в директорию /opt/adminlabs_backup.
 
-▎Пример файла backup.ini
+3. Командой sudo chmod +x backup_script.sh сделайте скрипт исполняемым.
+
+2. Отредактируйте файл конфигурации backup.ini.
+
+<h3>▎Пример файла backup.ini</h1>
 
 ``` ini
 [SENT]
@@ -47,26 +51,54 @@ FTP_USER=ваш_пользователь
 FTP_PASS=ваш_пароль
 [END]
 ```
+<h3>▎Описание переменных</h1>
 
-▎Запуск скрипта
+TELEGRAM_TOKEN - токен вашего бота Telegram
+
+CHAT_ID - ID вашего чата Telegram
+
+GOTIFY_URL - адрес вашего Gotify
+
+GOTIFY_APP_TOKEN - токен вашего приложения Gotify
+
+DIRS - список директорий для резервной копии
+
+FILES - список файлов для резервной копии
+
+SKIP_FILES - список файлов, которые не должны быть включены в резервную копию
+
+SKIP_DIRS - список директорий, которые не должны быть включены в резервную копию
+
+ENABLE_DIRS - флаг, указывающий, нужно ли включать директории в резервную копию
+
+ENABLE_FILES - флаг, указывающий, нужно ли включать файлы в резервную копию
+
+FTP_SERVER - адрес вашего FTP-сервера
+
+FTP_USER - имя пользователя вашего FTP-сервера
+
+FTP_PASS - пароль вашего FTP-сервера
+
+<h3>▎Запуск скрипта</h1>
 
 Запустите скрипт с правами суперпользователя:
 ``` bash
 sudo ./backup_script.sh
 ```
 
-▎Логирование
+<h3>▎Логирование</h1>
+
 
 Скрипт ведет логирование всех операций в файл, имя которого формируется на основе текущей даты и времени. Логи будут содержать информацию о выполнении операций, а также сообщения об ошибках.
 
-▎Примечания
+<h3>▎Примечание</h1>
 
 • Убедитесь, что у вас есть права доступа на чтение файлов и директорий, которые вы хотите сохранить.
 
 • Не храните чувствительные данные (например, пароли) в открытом виде в файле конфигурации. Рассмотрите возможность использования безопасных методов хранения конфиденциальной информации.
 
 
-▎Автоматическая установка
+<h1>▎Автоматическая установка</h1>
 
 • Для автоматической установки используйте выполните команду:
 
@@ -85,8 +117,10 @@ sudo crontab -e
 ```
 
 Добавьте новую строку для вашего скрипта в формате:
+``` bash
 
-* * * * * /путь/к/вашему/скрипту
+* * * * * /opt/adminlabs_backup/backup_script.sh
+```
 
 Здесь * обозначает минуты, часы, дни месяца, месяцы и дни недели соответственно.
 
@@ -130,6 +164,6 @@ sudo crontab -e
 
    После добавления нужной строки сохраните файл и выйдите из редактора. Cron автоматически применит изменения, и ваш скрипт будет выполняться по заданному расписанию.
 
-▎Лицензия
+<h1>▎Лицензия</h1>
 
 Этот проект лицензирован под MIT License. Пожалуйста, ознакомьтесь с файлом LICENSE для получения дополнительной информации.