Бекапи

Май копію своїх налаштувань, щоб повернути їх після невдалого оновлення, збою диска чи переїзду на новий комп’ютер.

Перш ніж почати

• Settings > Backups (Налаштування > Бекапи) потребує права Change settings (змінювати налаштування). Відновлює лише власник.
• Для завантаження, видалення й відновлення потрібен вхід з паролем, виконаний за останні кілька хвилин.

Зроби бекап

1. Відкрий Settings > Backups.
2. Натисни Back up now (зробити бекап зараз). Новий бекап має з’явитися в розділі Saved backups (збережені бекапи).
3. Натисни Download (завантажити) біля нього, щоб зберегти копію поза сервером.

Збережи головний ключ

У бекапах ніколи немає головного ключа, який відкриває паролі й API-ключі з твоїх налаштувань. Без відповідного ключа відновлений бекап не зможе їх прочитати.

1. У розділі Master key (головний ключ) власник натискає Download key kit (завантажити набір ключа).
2. Тримай файл подалі від сервера й окремо від бекапів. Попередження про набір ключа має зникнути з Settings > Backups і з перевірок справності.

Щоб скористатися ним пізніше, перейменуй його на holyarrs.key і поклади в теку конфігурації. Ти не власник? Попроси власника завантажити його.

Відновлення з бекапу

Небезпечно

Зміни, зроблені після бекапу, буде втрачено. Спочатку підготуй відповідний головний ключ.

1. Натисни Restore from a file (відновити з файлу) і обери zip-бекап HolyArrs.
2. Підтверди.
3. HolyArrs перевіряє файл. Ти маєш побачити Restore ready. It applies on the next start.
4. HolyArrs перезапускається й ставить бекап на місце. З рекомендованою політикою перезапуску Docker це відбувається само.

Твої поточні бази даних переносяться до /config/backups/before-restore-<time>, тож відновлення можна скасувати.

Варіанти

Як часто

Варіант	Коли робить бекап	Що зберігає
Balanced (збалансований; за замовчуванням)	Щодня	Останні 7 днів і 4 тижневі копії
Light (легкий)	Раз на тиждень	4 тижні. Займає найменше місця
Careful (ретельний)	Щодня	Кожна копія зберігається 30 днів

Найновіший бекап за розкладом зберігається завжди. Ці правила очищають лише бекапи за розкладом. Бекапи, які ти зробив сам, лишаються, доки ти їх не видалиш (кнопка кошика в рядку; скасувати не можна). HolyArrs також робить бекап перед оновленням, яке змінює збережені дані, і зберігає 3 найновіші; див. Оновлення.

Перехід на новий комп’ютер

Нове встановлення створює власний головний ключ під час першого запуску. Цей ключ не відкриє твої старі бекапи, тож відновлення буде відхилено. Спершу поклади на місце старий ключ. У прикладах контейнер називається holyarrs; підстав свою назву.

1. Перед першим запуском створи контейнер, не запускаючи його: docker compose create або свій рядок docker run, де замість docker run -d стоїть docker create.
2. Скопіюй старий ключ: docker cp holyarrs.key holyarrs:/config/. Набір ключа, перейменований на holyarrs.key, теж підходить. Це працює і для іменованого тому, і для теки на хості; HolyArrs передає файли в /config твоїм PUID і PGID під час запуску. Якщо ти користуєшся HOLYARRS_MASTER_KEY_FILE, поклади ключ за цим шляхом на хості, щоб його могли читати твої PUID і PGID.
3. Відновити бекап можна двома способами:

   • Запусти HolyArrs, пройди перший запуск і скористайся Restore from a file у Settings > Backups.

   • Або відновись до першого запуску. Поклади zip без зміни назви в теку backups і скопіюй її: docker cp backups holyarrs:/config/. Потім один раз виконай відновлення з тим самим образом:

     • Compose: docker compose run --rm holyarrs restore <zip name>
     • Docker CLI: docker run --rm --volumes-from holyarrs -e PUID=<puid> -e PGID=<pgid> holyarrs/holyarrs:<tag> restore <zip name>

     Якщо ключ лежить за окремим шляхом, додай -e HOLYARRS_MASTER_KEY_FILE=<its path>, щоб відновлення перевірялося з твоїм ключем. restore --list показує назви бекапів, які він бачить.

4. Запусти HolyArrs. Ти маєш побачити свою бібліотеку й налаштування на місці.

Запустив нове встановлення до копіювання ключа? Якщо на ньому немає нічого цінного, зупини HolyArrs, скопіюй старий ключ поверх нового тією самою командою docker cp, відновись і запусти.

Якщо не працює

Ознака: «Backups are off in this build». Причина: ця копія працює без менеджера бекапів. Рішення: у застосунку нічого не зробиш; елементів керування бекапами немає.

Ознака: для завантаження, видалення чи відновлення просить пароль. Причина: для цього потрібен нещодавній вхід з паролем. Рішення: увійди знову з паролем і повтори.

Ознака: відновлення відхилено через головний ключ. Причина: ключ у теці конфігурації не збігається з бекапом. Рішення: поклади на місце відповідний holyarrs.key і спробуй ще раз.

Відновлення також відхиляє zip, який завеликий або пошкоджений, містить неочікувані файли, походить від новішої версії бази даних або містить дані, яких твій ключ не може прочитати.

Для досвідчених

Що є в бекапі

Кожен бекап — це zip з основною базою даних, базою Events (якщо вона є) і backup.json (версія HolyArrs, версії баз даних, тип бекапу, час створення). Медіа, завантажень, ілюстрацій, логів і головного ключа в ньому немає.

Відновлення до першого запуску

docker cp працює і для іменованого тому, і для теки на хості; HolyArrs передає файли в /config твоїм PUID і PGID під час запуску. З HOLYARRS_MASTER_KEY_FILE поклади ключ за цим шляхом на хості, щоб його могли читати PUID і PGID.

1. Поклади zip без зміни назви в теку backups і скопіюй її: docker cp backups holyarrs:/config/.
2. Один раз виконай відновлення з тим самим образом:
   • Compose: docker compose run --rm holyarrs restore <zip name>
   • Docker CLI: docker run --rm --volumes-from holyarrs -e PUID=<puid> -e PGID=<pgid> holyarrs/holyarrs:<tag> restore <zip name>
3. Якщо ключ лежить за окремим шляхом, додай -e HOLYARRS_MASTER_KEY_FILE=<its path>, щоб відновлення перевірялося з твоїм ключем.
4. Запусти HolyArrs.

restore --list показує назви бекапів, які він бачить.

Пов’язане

• Оновлення
• Встановлення
• Перевірки справності