====== Документация по резервному копированию X-Road ======

===== Введение =====

Данная документация описывает процесс создания резервных копий конфигурации X-Road Security Server, их расшифровки и восстановления.

==== Создание резервной копии ====

Для создания резервной копии конфигурации Security Server используется скрипт backup_xroad_proxy_configuration.sh.
Синтаксис команды
<code>
 /usr/share/xroad/scripts/backup_xroad_proxy_configuration.sh -s <server-id> -f <backup-file>
</code>

Параметры
-s — идентификатор сервера в формате central-server/class/code/subsystem
-f — путь и имя файла резервной копии

Пример использования:
<code>
/usr/share/xroad/scripts/backup_xroad_proxy_configuration.sh \
  -s central-server/GOV/70000011/gkitis-server \
  -f /var/lib/xroad/backup/conf_backup_$(date +%Y%m%d-%H%M%S).gpg
</code>

<note warning>Важно
Идентификатор сервера central-server/GOV/70000011/gkitis-server является примером. У каждого пользователя этот идентификатор будет отличаться в зависимости от настроек его Security Server.</note>

Резервная копия создается в зашифрованном формате GPG и сохраняется с расширением .gpg.

=== Расшифровка резервной копии ===

Для просмотра или извлечения содержимого резервной копии необходимо расшифровать GPG-файл.

Синтаксис команды
<code>
gpg --homedir /etc/xroad/gpghome --decrypt <encrypted-backup> > <output-tar>
</code>

Пример использования
<code>
gpg --homedir /etc/xroad/gpghome \
  --decrypt conf_backup_20251122-220238.gpg > backup.tar
</code>

После расшифровки вы получите TAR-архив, который можно распаковать стандартными средствами для просмотра содержимого или использовать для восстановления.

== Восстановление из резервной копии ==

Для восстановления конфигурации Security Server из резервной копии используется скрипт restore_xroad_proxy_configuration.sh.

Синтаксис команды
<code>
/usr/share/xroad/scripts/restore_xroad_proxy_configuration.sh -s <server-id> -f <backup-file> -P
</code>

Параметры
-s — идентификатор сервера (должен совпадать с тем, что использовался при создании бекапа)
-f — путь к TAR-файлу резервной копии
-P — принудительное восстановление без подтверждения

Пример использования
<code>
/usr/share/xroad/scripts/restore_xroad_proxy_configuration.sh \
  -s central-server/GOV/70000011/gkitis-server \
  -f /var/lib/xroad/backup/test.tar \
  -P
</code>

Примечания
Перед восстановлением необходимо расшифровать GPG-файл в TAR-архив, как описано в разделе "Расшифровка резервной копии".

Процесс восстановления перезапишет текущую конфигурацию Security Server, поэтому рекомендуется предварительно создать актуальную резервную копию.

Рекомендации
Регулярно создавайте резервные копии конфигурации, особенно перед внесением значительных изменений в настройки Security Server.
Храните резервные копии в безопасном месте с ограниченным доступом, так как они содержат критически важные конфигурационные данные.
Используйте в именах файлов резервных копий временные метки для упрощения идентификации и управления версиями.
Периодически проверяйте возможность восстановления из резервных копий в тестовой среде.

-----
Автор Даниил Горбенко