docs: added readme

2026-04-17 01:48:46 +04:00
parent 7ec84e0bf3
commit 8f4cc59b03
1 changed files with 52 additions and 0 deletions
@@ -0,0 +1,52 @@
+# rclone-backup
+
+Скрипт для автоматизации бэкапов с помощью rclone в облако Яндекс.Диск с уведомлениями в ntfy.
+
+## Конфиг
+
+```bash
+SOURCE="/mnt/backup/data"             # Источник
+REMOTE="yandex:backup_folder"         # Назначение
+MAX_AGE="24h"                         # Срок актуальности файлов
+BW_LIMIT="5M"                         # Ограничение скорости
+NTFY_URL="https://ntfy.sh/topic"      # Ссылка на топик ntfy
+AUTH="user:password"                  # Заголовок с авторизацией для ntfy
+SERVICE="MyServer"                    # Имя сервиса для заголовка
+FILTER="{*.tar.gz,*.zst,*.lst}"       # Маска для файлов
+LOG_FILE="/var/log/rclone-backup.log" # Лог-файл
+```
+
+## Использование
+
+### Запуск бэкапа вручную:
+
+```bash
+./backup.sh my-backup.env
+```
+
+### Добавление в Cron
+
+Для ежедневного запуска в 05:00:
+
+```bash
+0 5 * * * /opt/rclone-backup/rclone-backup.sh /opt/rclone-backup/config.env
+```
+
+## Вывод
+
+Пример лога:
+
+```log
+2026/04/16 21:28:11 Cloning BananaWrt
+2026/04/16 21:28:15 NOTICE: Yandex backup_bananawrt: 0 differences found
+2026/04/16 21:28:15 NOTICE: Yandex backup_bananawrt: 82 matching files
+2026/04/16 21:28:51 Cloning Proxmox
+2026/04/16 21:29:25 NOTICE: Yandex backup_proxmox: 0 differences found
+2026/04/16 21:29:25 NOTICE: Yandex backup_proxmox: 51 matching files
+```
+
+<details>
+  <summary>Скриншот ntfy</summary>
+
+![ntfy](./assets/ntfy.jpg)
+</details>