Перейти к содержимому

Как это работает

Резервная копия и восстановление панели

Как сохранить саму панель (её базу, ключи шифрования, лицензию и конфигурацию) в один зашифрованный архив и восстановить её на чистом сервере двумя командами.

Резервные копии аккаунтов содержат файлы и базы данных ваших клиентов. Самой панели в них нет: её базы данных (администраторы, аккаунты, тарифы, сайты, расписания, журнал аудита), ключа, которым зашифрован каждый хранимый секрет, лицензии и /etc/maran. Без ключа новый сервер не прочитает даже секреты из скопированной базы. maran panel-backup и maran panel-restore закрывают этот пробел.

Обе команды доступны только root, как и вся команда maran. При ручном запуске они не добавляют ни службы, ни порта, ни сетевых обращений. Необязательное расписание, описанное ниже, добавляет таймер systemd и, только если вы это настроите, одну исходящую выгрузку по HTTPS.

Файл с парольной фразой

Архив шифруется выбранной вами парольной фразой, которая читается из файла. Создайте его один раз:

bash
sudo install -m 0600 /dev/null /root/maran-backup.passphrase
sudo editor /root/maran-backup.passphrase

Файл должен быть обычным файлом (не символической ссылкой), принадлежать root, иметь режим 0600 или 0400 и содержать одну строку не короче 20 символов. Всё остальное отклоняется до того, как что-либо записано. Парольная фраза никогда не передаётся в командной строке или в окружении.

Храните копию фразы вне сервера и не там, где лежат архивы. Без неё архив не откроет никто, включая вас.

Сделать резервную копию

bash
sudo /usr/local/sbin/maran panel-backup --passphrase-file /root/maran-backup.passphrase

Команда записывает maran-panel-backup-<время UTC>-<pid>.tar.gpg с режимом 0600 в /root и печатает путь. --out DIR выбирает другой каталог: абсолютный путь, принадлежащий root и недоступный для записи группе и остальным. Панель продолжает работать во время копирования. Неудачный запуск не оставляет частичного файла.

Скопируйте архив с сервера. Тот, у кого есть архив и парольная фраза, владеет панелью.

Что внутри архива

ЧастьВосстанавливается panel-restore
База данных панели, все схемыда
Security__EncryptionKey и Jwt__SigningKey из /etc/maran/panel.envда
/var/lib/maran/licence.jsonда
Остальное из /etc/maran и /var/lib/maran (TLS-ключ панели, сгенерированные конфигурации, данные ACME)нет, лежит в архиве для ручного использования

Всё остальное в panel.env (имя хоста, порты ssh, uid веб-сервера) описывает сервер, на котором оно находится, поэтому восстановление сохраняет то, что записала новая установка.

Архив шифруется gpg, AES-256, с защитой целостности: изменённый или обрезанный архив отклоняется и никогда не восстанавливается.

Восстановить на чистом сервере

  1. Установите Maran на новый сервер: тот же выпуск, что и у копии, или новее. Не создавайте администратора в браузере.
  2. Скопируйте архив на новый сервер с владельцем root и создайте там файл с парольной фразой.
  3. Восстановите:
    bash
    sudo /usr/local/sbin/maran panel-restore --passphrase-file /root/maran-backup.passphrase \
      --replace-this-panel /root/maran-panel-backup-20261101T120000Z-4242.tar.gpg
    
  4. Войдите администратором старой панели. Все сеансы старого сервера завершены.
  5. Восстановите файлы, сайты и базы данных клиентов из резервных копий аккаунтов: копия панели содержит её записи о них, а не их содержимое.

Порядок восстановления

  1. Расшифровать и проверить архив и версию его формата.
  2. Проверить два ключа в сохранённом panel.env.
  3. Остановить панель.
  4. Заменить базу данных одной транзакцией.
  5. Записать два ключа в panel.env этого сервера.
  6. Вернуть лицензию.
  7. Применить миграции этого выпуска.
  8. Запустить панель.

Если замена базы не удаётся, её транзакция откатывается, и база остаётся такой, какой её оставила установка. Что бы ни сорвалось после остановки панели, панель запускается снова.

Что отклоняется

  • запуск без --replace-this-panel: восстановление заменяет базу и ключи этой панели;
  • файл с парольной фразой, не соответствующий правилам выше;
  • архив, путь к которому не абсолютный, который не является обычным файлом или не принадлежит root;
  • сервер без /etc/maran/panel.env: сначала установите Maran;
  • неверная парольная фраза или повреждённый архив (отказ происходит до каких-либо изменений);
  • формат архива, который этот выпуск не восстанавливает;
  • второе копирование или восстановление, пока идёт первое.

Ничего из архива не исполняется. Из него извлекаются только названные файлы, а ключи проверяются перед записью.

Расписание, хранение нескольких копий и копия вне сервера

Расписания, хранения копий и выгрузки в S3 в 1.0.0-beta.4 нет, они появятся в следующем выпуске. В 1.0.0-beta.4 запускайте maran panel-backup из crontab root и копируйте файл своими средствами.

Начиная со следующего выпуска установщик кладёт на сервер таймер и его службу, но никогда их не включает. Сначала вы пишете файл настроек:

bash
sudo install -d -m 0700 /etc/maran-backup
sudo install -m 0600 /dev/null /etc/maran-backup/passphrase
sudo editor /etc/maran-backup/passphrase
sudo install -m 0600 /usr/local/maran/cli/panel-backup.conf.example /etc/maran/panel-backup.conf
sudo editor /etc/maran/panel-backup.conf
sudo /usr/local/sbin/maran panel-backup-schedule enable

/etc/maran/panel-backup.conf это данные, а не shell-скрипт: одна строка КЛЮЧ=ЗНАЧЕНИЕ, без кавычек и пробелов, неизвестный или повторённый ключ отклоняется. Владелец файла root, права 0600. Секретов в нём нет, он лишь называет файлы, где они лежат:

КлючЗначение
PASSPHRASE_FILEОбязателен. Файл с парольной фразой, правила те же, что выше.
OUT_DIRКуда писать архивы. По умолчанию /var/backups/maran-panel, его создаёт установщик, доступ только у root. Другой каталог должен уже существовать (владелец root, права 0700).
KEEPСколько архивов хранить, от 1 до 365. По умолчанию 14.
SCHEDULEКогда запускать, в формате календарного времени systemd, например *-*-* 02:30:00 (по умолчанию, каждый день) или Sun *-*-* 03:00:00; подходят также hourly, daily, weekly и monthly. Таймер добавляет случайную задержку до 15 минут.
S3_ENDPOINT, S3_BUCKET, S3_REGION, S3_ACCESS_KEY_ID_FILE, S3_SECRET_FILE, S3_PREFIXНеобязательная выгрузка. Задайте все ключи, кроме S3_PREFIX (необязательная папка в бакете), или ни одного. В двух файлах с учётными данными лежит по одному значению.

Храните файл с парольной фразой и файлы с учётными данными S3 вне /root и /home, например в /etc/maran-backup (владелец root, права 0700, у каждого файла 0600). Запланированное задание этих двух деревьев не видит, и enable отклонит путь внутри них. Не кладите их и в /etc/maran: этот каталог входит в архив, а парольная фраза внутри архива, который она защищает, ничего не защищает.

enable проверяет файл и расписание, затем запускает таймер. Если что-то не так, он называет первую проблему и ничего не меняет. Дальше:

bash
sudo /usr/local/sbin/maran panel-backup-schedule status
sudo /usr/local/sbin/maran panel-backup-schedule disable

status показывает, включён ли и активен ли таймер, время следующего и последнего запуска и чем закончился последний. disable останавливает таймер и оставляет на месте настройки и все архивы.

Каждый запуск делает ту же копию, что и ручной, от имени root по таймеру. Если машина в назначенное время была выключена, копия делается при её следующем запуске. Затем по порядку:

  1. Хранение. Только после того как новый архив готов, остаются KEEP самых новых. Более старые удаляются из OUT_DIR, причём только обычные файлы, чьё имя целиком совпадает с maran-panel-backup-<время UTC>-<pid>.tar.gpg. Всё остальное в каталоге не трогается. Копий в S3 хранение никогда не касается.
  2. Выгрузка, только если задан S3_ENDPOINT. Уже зашифрованный файл .tar.gpg отправляется по HTTPS (TLS 1.2 и новее, без перенаправлений, сертификат проверяется всегда), и выгрузка считается выполненной, только когда размер сохранённого объекта равен размеру локального файла. Сетевая ошибка или ответ 5xx повторяются три раза с паузой десять секунд. Учётные данные никогда не попадают в командную строку или журнал.

Если хранение или выгрузка не удались, архив остаётся на сервере, а запуск считается неудачным (systemctl status maran-panel-backup.service). Каждый запуск оставляет в системном журнале одну строку с тегом maran-cli: итог и ничего больше. При удалении Maran таймер удаляется, архивы никогда.

Чтобы восстановиться из копии вне сервера, скачайте файл .tar.gpg на новый сервер, владелец root, и выполните шаги из раздела Восстановить на чистом сервере. Парольная фраза остаётся той, которой он зашифрован.

Ограничения

  • Хранение, расписание и выгрузка работают со следующего выпуска, как описано выше. Выгрузка обращается по протоколу S3 к указанной вами конечной точке и только по HTTPS. Команды, которая забирает архив обратно из S3, нет: скачайте его своими средствами.
  • Восстановление архива более нового выпуска на более старую установку командой не отклоняется. Сначала установите тот же выпуск или новее.
  • Лицензию, привязанную к старому серверу, может потребоваться перевыпустить для нового.
  • TLS-сертификат панели, сгенерированные конфигурации и данные ACME автоматически не возвращаются; при необходимости возьмите их из архива вручную.
  • Если во время копирования пропадёт питание, незашифрованная промежуточная копия останется в каталоге, доступном только root, до следующего запуска любой из двух команд.