Перейти к содержанию

Конфигурация

Эта страница охватывает переменные окружения контейнера, монтирования, которые даёт шаблон, модель безопасности, копирование виртуальных машин по SSH и настройку внешних копий. Куда идут копии, настраивается внутри приложения как места назначения, а не через переменные окружения.

Переменные окружения

Переменная Обязательна Описание
APP_KEY Да Секрет из 32 байт в шестнадцатеричной записи (64 шестнадцатеричных символа), из которого выводится пароль репозитория restic. Сгенерируйте командой openssl rand -hex 32. Храните его в надёжном месте: потеря делает зашифрованные копии невосстановимыми.
LIBVIRT_HOST Для виртуальных машин и наборов данных ZFS Хост Unraid, к которому обращаются по SSH для копий виртуальных машин и наборов данных ZFS (поле шаблона Host SSH: Address, по умолчанию host.docker.internal). Шаблон подставляет заглушку 192.168.x.x, которая считается незаданной. Используйте IP вашего Unraid в локальной сети, он обязателен в пользовательской сети br0.x. Когда host.docker.internal не разрешается, как в приложении TrueNAS, и LIBVIRT_URI тоже не называет хост, BombVault использует шлюз контейнера по умолчанию, и журнал загрузки его называет.
LIBVIRT_SSH_PORT Нет Порт SSH хоста для копий виртуальных машин и наборов данных ZFS (поле шаблона Host SSH: Port, по умолчанию 22).
LIBVIRT_SSH_USER Нет Пользователь SSH на хосте для копий виртуальных машин и наборов данных ZFS (поле шаблона Host SSH: User, по умолчанию root).
LIBVIRT_URI Нет Полный URI подключения к libvirt, используемый как есть вместо построения из трёх переменных LIBVIRT_* выше (которые тогда игнорируются для строки подключения). По умолчанию не задан. Нужен на TrueNAS Scale, чей libvirtd слушает нестандартный сокет, который форма составной строки выразить не может: qemu+ssh://<user>@<truenas-host>/system?socket=/run/truenas_libvirt/libvirt-sock. См. руководство по копированию виртуальных машин. Если это URI qemu+ssh://, каждая из переменных LIBVIRT_HOST, LIBVIRT_SSH_USER и LIBVIRT_SSH_PORT, которая не задана, берётся из него, в том числе для собственных команд SSH BombVault (перенос NVRAM, наборы данных ZFS).
PORT Нет Порт HTTP (по умолчанию 3000. Используется только с HTTP_ONLY=true).
HTTPS_PORT Нет Порт HTTPS (по умолчанию 3443. Шаблон публикует его один к одному, так что веб-интерфейс отвечает на https://<ip>:3443).
HTTP_ONLY Нет Задайте true, чтобы отключить самоподписанный слушатель HTTPS и отдавать только обычный HTTP (для работы за обратным прокси, который завершает TLS).
BIND_HOST Нет Адрес, на котором слушает веб-интерфейс (по умолчанию 0.0.0.0, все интерфейсы). В контейнере оставьте его незаданным, потому что опубликованным портам нужны все интерфейсы. 127.0.0.1 подходит для запуска вне Docker. Проверка работоспособности спрашивает тот же адрес.
TRUSTED_PROXY Нет Адреса или диапазоны CIDR обратного прокси перед BombVault через запятую (например 192.168.20.11 или 10.0.0.0/8). Только от этих узлов X-Forwarded-For принимается на веру, а ограничитель входа тогда считает неудачи по настоящему клиенту, а не сваливает всех, кто за прокси, в одну корзину. Если не задано (по умолчанию), не доверяется никому: заголовок, принимаемый безоговорочно, позволил бы любому вызывающему выбрать свою корзину.
HOST_SOURCE_ROOT Нет Путь хоста, подключённый как Host Data (по умолчанию /mnt). BombVault переводит источники bind-монтирований, о которых сообщает Docker, в пути внутри этого монтирования. Меняйте, только если вы подключили другой корень хоста.
HOST_MOUNT_ROOT Нет Где Host Data смонтирован внутри контейнера (по умолчанию /host/user). В TrueNAS Host Data монтируется по собственному пути хоста, поэтому и эта переменная, и HOST_SOURCE_ROOT называют этот путь, например /mnt/tank (см. TrueNAS SCALE).
DATA_ROOT_SEGMENTS Нет Названия сегментов пути через запятую, по которым источник bind-монтирования считается данными для копирования (по умолчанию appdata, по соглашению Unraid /mnt/user/appdata/<container>). Bind-монтирование контейнера выбирается для копирования автоматически, когда ЛЮБОЙ перечисленный сегмент встречается как целый сегмент пути его источника на хосте. Например, DATA_ROOT_SEGMENTS=appdata,config подхватывает и bind .../config. Сопоставление не учитывает регистр, так что значение по умолчанию охватывает и /DATA/AppData/<container> в ZimaOS. Другие, всегда включённые способы найти папку данных контейнера см. в разделе Определение источника копии.
PLATFORM Нет Принудительно задаёт, на какой платформе BombVault считает себя работающим, вместо автоопределения: unraid, generic или truenas (по умолчанию не задано: Unraid определяется по маркеру dockerMan в точке монтирования флешки, иначе generic. Нераспознанное значение тоже сводится к generic с записью в журнал). Задавайте явно на обычном хосте Docker или TrueNAS Scale, а не полагайтесь на автопроверку только для Unraid. Общий файл compose делает это. Меняет соглашение запасного варианта для appdata, значения по умолчанию для целей восстановления между экземплярами и то, пробуются ли вообще шаги уведомлений и сопутствующих плагинов только для Unraid (см. internal/platform).
BOMBVAULT_SELF_CONTAINER Нет Имя самого контейнера BombVault, чтобы он никогда не копировал (и тем самым не останавливал) сам себя.
BACKUP_MAX_HOURS Нет Максимум часов реального времени, в течение которых один запуск копирования может держать блокировку своего раздела, прежде чем его принудительно отменят (защита, чтобы застрявший запуск не заблокировал раздел навсегда). Если пусто (по умолчанию), используется 48. Увеличьте для очень больших или медленных облачных копий (запуск, отменённый по пределу, завершается ошибкой context deadline exceeded). Задайте 0, чтобы полностью отключить предел. Очистка подчиняется тому же пределу, а проверка или очистка идёт, пока restic продолжает сообщать о ходе.
BACKUP_STALL_HOURS Нет Сколько часов копия может вообще не продвигаться, прежде чем её отменят. Если пусто (по умолчанию), используется 2. Задайте 0, чтобы никогда не отменять из-за застоя. Это более тонкая из двух защит, и обычно срабатывает именно она: она следит, происходит ли что-нибудь, а не сколько времени занял запуск, так что медленная, но здоровая копия на несколько терабайт остаётся в покое, а застрявшая на не отвечающем общем ресурсе останавливается за часы, а не за дни. Предупреждение пишется в журнал после 30 минут тишины, прежде чем что-то отменяется. Сканирование считается продвижением: restic не пишет байты, пока обходит большое дерево, и эта фаза отслеживается по итогам файлов и байтов, а не по записанным байтам. Эти две переменные независимы, а BACKUP_MAX_HOURS по-прежнему ограничивает фазы после самой копии (хранение, статистика, внешняя копия), где нет счётчиков для наблюдения.
DB_DUMP_MAX_HOURS Нет Сколько часов может идти один автоматический дамп базы данных, прежде чем его остановят. Если пусто (по умолчанию), используется 6. Допустимые значения от 1 до 48, а предел держится на час ниже BACKUP_MAX_HOURS (на половине от него, если тот меньше двух часов), так что долгий дамп обрывается по собственному пределу и так и сообщается, а не тянет за собой копию. Дамп, который не продвигается, останавливается раньше, через BACKUP_STALL_HOURS. Остановленный дамп завершается ошибкой сам по себе, а копия контейнера продолжается. В Unraid добавьте её в контейнер BombVault через Add another Path, Port, Variable.
TZ Нет Часовой пояс для планировщика (например Europe/Berlin). Если оставить незаданным, каждое расписание идёт по UTC: заданное на 02:30 тогда сработает в 02:30 UTC, а не по вашим настенным часам. В Unraid вы сами никогда его не задаёте: система передаёт свой часовой пояс в каждый контейнер. Журнал загрузки говорит, какой пояс определился. Пояс с переходом на летнее время пропускает один запуск весной и выполняет один дважды осенью, а UTC не делает ни того, ни другого, но дважды в год расходится с вашими часами на час.
DATA_DIR Нет Где BombVault хранит свою базу данных, ключи и кэши (по умолчанию /config). В контейнере не трогайте. Важно при запуске бинарного файла вне Docker.
FLASH_DIR, FLASH_TEMPLATES_DIR Нет Где флешка и её шаблоны Docker смонтированы внутри контейнера (по умолчанию /host/boot и /host/boot/config/plugins/dockerMan/templates-user). Они следуют монтированию /boot шаблона, поэтому оставьте их незаданными.
MODE Нет full (по умолчанию) запускает всё приложение. node запускает узел: без веб-интерфейса и без собственных расписаний, только то, что ему говорит его домашний экземпляр. Любое другое значение останавливает запуск с сообщением. Домашний экземпляр сам вписывает его в compose-файл узла.
NODE_HOME На узле К какому домашнему экземпляру относится узел, вместе с ключом и Relay этого экземпляра, одним значением, которое начинается с bvhome1.. Домашний экземпляр записывает его в compose-файл узла. Без него узел запускается, но ни один домашний экземпляр до него не достанет. Узел, который принял домашний экземпляр, отказывается запускаться, если NODE_HOME называет другой, пока прежний его не отвяжет.
NODE_NAME Нет Имя узла, как его вписал домашний экземпляр по названию, которое вы ему дали.

Монтирования

Подключите сокет Docker, флешку (/boot) и корень Host Data (/mnt), как показано в шаблоне CA. И источники, и назначения копий лежат внутри Host Data, и он монтируется как slave, чтобы удалённый общий ресурс, который монтируется после запуска контейнера (например в /mnt/remotes), стал виден без перезапуска.

В TrueNAS Host Data — это путь набора данных вроде /mnt/tank, но никогда не ixVolume. Данные, которые приложение хранит в ixVolume, лежат вне него и не копируются. См. TrueNAS SCALE.

Копии наборов данных ZFS тоже нужен этот режим: хост монтирует снимок набора данных только после запуска контейнера. См. Наборы данных ZFS.

Локальные репозитории по умолчанию лежат в /mnt/user/bombvault/{container,vms,flash,config,files,zfs} и создаются при первой копии. Это собственные папки разделов, и вместе они образуют место назначения Локально. На его странице в Места назначения карточка Подключение меняет папку каждого раздела.

Собственная папка раздела может лежать и в уже существующем у вас месте назначения, например NAS или бакете S3: Использовать как собственную папку на странице этого места переносит её туда и сначала говорит, что произойдёт с уже сделанными копиями. См. Собственная папка раздела.

Папки локальных репозиториев остаются с режимами 0755 и 0644, чтобы пользователь синхронизации без прав root по SMB не был заперт снаружи, а репозитории зашифрованы, так что это ничего не раскрывает. Определения для восстановления лежат внутри каждого репозитория, поэтому скопированная папка полна сама по себе. Репозиторий автобэкапа остаётся читаемым только для root.

Проверка интеграции с хостом

Карточка Интеграция с хостом в обзоре (добавьте её через Настроить) проверяет каждое монтирование и каждую утилиту командной строки (сокет Docker, libvirt, restic, qemu-img, rclone) и сообщает, чего не хватает.

Определение источника копии

Для каждого контейнера BombVault автоматически выбирает, какие bind-монтирования и именованные тома копировать. Путь подхватывается, когда выполняется любое из следующих условий (результат всегда можно переопределить в карточке Папки для резервного копирования на вкладке контейнера «Настройки»):

  • Совпадение с сегментом корня данных: источник bind-монтирования на хосте содержит один из сегментов DATA_ROOT_SEGMENTS как целую часть пути (по умолчанию только appdata).
  • Именованные тома Docker включаются всегда, потому что у них нет одноразового аналога и фильтровать нечего, но только когда реальный путь хранения тома на хосте сам достижим через монтирование Host Data, как и любой другой путь хоста, который копирует BombVault. Драйвер локальных томов Docker по умолчанию хранит том в собственном корне данных демона (/var/lib/docker/volumes/<name>/_data, если вы не изменяли. Проверьте командой docker info -f '{{.DockerRootDir}}'), который не охватывается узким монтированием Host Data из одного каталога, которое общий docker-compose.yml использует по умолчанию. Недостижимый том молча пропускается, это не ошибка. Чтобы на самом деле копировать именованные тома на обычном хосте, направьте Host Data (и HOST_SOURCE_ROOT) на общего предка, который охватывает и корень данных Docker. Комментарий о Host Data в файле compose объясняет компромисс (Unraid обходит это, монтируя весь /mnt, своё универсальное соглашение верхнего уровня, по той же причине).
  • Каталог проекта Docker Compose: если у контейнера есть стандартная метка com.docker.compose.project.working_dir (её ставит docker compose up автоматически), этот каталог тоже добавляется, независимо от того, совпал ли какой-либо bind с сегментом корня данных.
  • Переопределение меткой bombvault.data: задайте метку bombvault.data=true на контейнере, чтобы включить все его bind-монтирования, для раскладки, которую не ловит ни одно из соглашений выше (например единственный bind /srv/plex/config без проекта Compose). Любое непустое значение, кроме false, считается истинным. Отсутствующая метка или bombvault.data=false ничего не меняют.
  • Метка bombvault.dbdump: задайте bombvault.dbdump=false на контейнере, чтобы отключить его автоматический дамп базы данных (0, no и off делают то же), или назовите движок (postgres, mysql, mariadb), чтобы делать дамп контейнера, который BombVault сам не распознаёт. Метка главнее переключателя в карточке База данных на вкладке контейнера «Настройки», и в Unraid делать нужно так.

Модель безопасности

Управление хостом на уровне root

Через сокет Docker BombVault может останавливать, удалять и пересоздавать контейнеры и читать и записывать appdata, а для копий виртуальных машин он входит на хост по SSH (qemu+ssh://, по умолчанию root), чтобы запускать virsh. Любой, кто может достучаться до его веб-интерфейса, фактически получает root на хосте.

Вход

  • Необязательная защита паролем (карточка Пароль в Настройки, Безопасность): задайте пароль, чтобы требовать вход, очистите его, чтобы отключить. По умолчанию выключено для использования в доверенной локальной сети. Пароль хранится с Argon2id поверх перца, привязанного к APP_KEY, так что скопированный /config бесполезен без ключа и медленно взламывается даже с ним. Новому паролю нужно не меньше 12 символов. Существующий более короткий продолжает работать, пока его не изменят. Сеансы подписаны (HMAC, выведенный из APP_KEY), и смена пароля делает их недействительными. Входы ограничены пятью неудачами в минуту на клиента. Чтобы изменить или убрать пароль, нужен Текущий пароль и, если включена двухфакторная аутентификация, код.
  • Кое-что требует пароля. Скачивание набора для восстановления, отчёта об ошибке и ZIP копии флешки, экспорт копии флешки или автобэкапа, передача ключа хранителю ключа, разрешение выдать переданный на хранение ключ, создание нового кода восстановления, экспорт настроек с учётными данными, двухфакторная аутентификация, ключи доступа, добавление узла, повторный показ compose-файла узла и открытие записей узла отклоняются, пока не задан пароль для входа, и для них нужен вход на самом экземпляре. Удаление копий работает и без пароля. Если пароль задан, для него тоже нужен этот вход.
  • Место назначения не показывает пароль. Место назначения может содержать учётные данные, как в rest:https://user:password@host/repo, и каждая страница и каждый ответ API показывают его как rest:https://[redacted]@host/repo, с паролем для входа или без него. Если изменить путь за ним, сохранённый пароль остаётся. Чтобы направить место назначения на другой сервер, введите его целиком вместе с паролем, потому что скрытый пароль остаётся со своим сервером.
  • Двухфакторная аутентификация (Настройки, Безопасность): временной код из приложения-аутентификатора поверх пароля плюс восемь одноразовых кодов восстановления, которые выдаются один раз при её включении. Общий секрет хранится зашифрованным через APP_KEY, а чтобы снова выключить фактор, нужен действующий код.
  • Ключи доступа (WebAuthn) стоят на своей карточке, как только задан пароль, рядом с паролем и никогда не вместо него, так что удаление всех ключей доступа никого не запирает снаружи. Им нужны настоящее доменное имя и сертификат, которому доверяет браузер. Адрес по умолчанию https://<ip>:3443 — именно то, что WebAuthn отклоняет, и карточка так и говорит, а не предлагает кнопку, которая не сработает. При включённой двухфакторной аутентификации ключ доступа должен проверить ваш PIN, отпечаток пальца или лицо, иначе вход просит ещё и код.
  • Восстановление конфигурации (Вернуть настройки в аварийном мастере) завершает все сеансы, удаляет все ключи доступа и отзывает все токены API и ключи MCP, потому что восстановленные настройки могли бы вернуть те, что были удалены после их сохранения. Войдите с паролем и настройте ключи доступа заново в Настройки, Безопасность.
  • Забытый пароль сбрасывается на странице входа. Забыли пароль? заставляет BombVault записать код из 12 символов, тремя группами по четыре, в журнал своего контейнера (в Unraid: вкладка Docker, значок BombVault, Логи). Этот код и новый пароль вас впускают. Сброс также выключает двухфакторную аутентификацию, удаляет все ключи доступа, отзывает все токены API, ключи MCP и входы OAuth, завершает все остальные сеансы, выводит из сеанса все сопряжённые телефоны и выключает сопряжение телефонов. Страница после этого перечисляет, что исчезло. Код действует 10 минут, а неверные попытки его не расходуют. Токены виджета и метрик остаются, потому что они только читают.
  • Сбросить пароль может любой, кто может читать журнал контейнера. Это root на хосте, но также просмотрщик журналов вроде Dozzle, любой контейнер с доступом к сокету Docker (достаточно только чтения) и отправитель журналов, пересылающий вывод контейнеров. Давайте это только тем, кому доверили бы и сам пароль. Тот, кто достаёт только до веб-интерфейса, код никогда не видит.

Телефоны и участники группы

  • Сопряжённые телефоны достают до списка разрешённого. Телефон, знающий двенадцать слов группы, входит без пароля, пока включено Телефоны можно сопрягать по двенадцати словам группы в карточке Приложение для Android в Настройки, Безопасность. Его сеанс достаёт только до того, что показывает приложение: обзор, запуски, копии для просмотра, запуска и восстановления, аномалии для чтения и страница «Экземпляры» для просмотра. Места назначения и команды доходят до него с удалёнными адресами и секретами, а восстановление, заменяющее оригинал, сначала копирует текущее состояние. Восстановление в папку принимает только новую или пустую папку внутри папки восстановления, а заглянуть в другую папку телефон не может. На всё остальное сервер отвечает, что нужен вход на самом экземпляре: ключи, набор для восстановления, передача ключей на хранение, настройки, удаление копий. Сброс пароля выключает сопряжение телефонов, пока вы не включите его снова. Телефон, удалённый со страницы «Экземпляры» или с выключенным Опрашивать этот экземпляр в его подробностях, сразу теряет сеанс, а удалённый телефон, который снова открывает своё приложение, возвращается выключенным.
  • Вне дома телефон открывает страницы через ретранслятор. Каждый запрос страницы запечатывается ключом группы, который ретранслятор не может ни прочитать, ни изменить, и подписывается собственным ключом телефона, который сервер закрепляет при первом обращении телефона и впускает, как только кто-то одобрит телефон на странице сопряжения. Сервер выполняет запрос один раз и только пока он свежий. Он отвечает только телефону, перечисленному на странице «Экземпляры», пока сопряжение телефонов включено, и только сеансом, который сам дал этому телефону, так что выход везде и сброс пароля завершают и эти страницы. Сервер подписывает каждый ответ, а приложение проверяет подпись по ключу, который закрепило для этого сервера, и предупреждает, когда ключ меняется. Такая страница достаёт до того же списка разрешённого, что и сопряжённый телефон, с паролем для входа или без него, плюс до состояния входа, которое страница читает первым. Вход и выход, сброс пароля и скачивания остаются на собственном адресе сервера, а один ответ ограничен 16 МБ.
  • Участники подписывают то, о чём просят. Запросы ролей и ответы на них, предложения хранилища, выдача пароля restic приёмнику или подтягивающему, входы приёмника и передача ключей на хранение подписываются ключом каждого участника, который экземпляр закрепляет, когда впервые видит этого участника. Вызов, подписанный другим ключом, отклоняется. Забыть ключ в подробностях экземпляра сбрасывает закреплённый ключ на случай, если известный здесь не собственный ключ участника. Ключ у участника запрашивается снова при его следующем подписанном вызове. Участники на BombVault 9.x не подписывают, и любой, кто знает слова, может выдать себя за них, как в 9.9. Запрос роли или предложение хранилища от участника на версии 10.4 или старше отклоняется, пока этот участник не обновится.
  • Двенадцать слов — это пароль. Любой, кто их знает, вступает в группу, видит состояние защиты участников и может запрашивать роли, которые человек на другом экземпляре всё же должен разрешить. Без пароля для входа любой, кто может открыть веб-интерфейс, может их прочитать, и карточка сопряжения об этом пишет, пока пароль не задан.

Ключи

  • APP_KEY делает две вещи. Он запечатывает то, что хранит эта установка (пароли, учётные данные, токены), и он же ключ копий: из него выводится пароль restic, и им запечатаны определения контейнеров и виртуальных машин.
  • Взятый ключ хранится отдельно. Когда аварийный мастер берёт копии другого сервера, эта установка продолжает запечатывать своим APP_KEY, а ключ другого сервера хранит как свой ключ копий, запечатанный как любой другой секрет. Набор для восстановления тогда печатает оба. Если APP_KEY потом изменить, ключ копий больше не откроется: BombVault прекращает копирование и сообщает об этом в Требует внимания, а не пишет неправильным ключом. Загрузите набор для восстановления заново в Восстановление, Аварийное или верните APP_KEY. См. Аварийный мастер.
  • Шифрование включено по умолчанию (Шифровать копии в карточке Шифрование в Настройки, Безопасность). Копии шифрует restic с паролем, выведенным из ключа копий.
  • Передача ключей на хранение. Хранитель ключа в вашей группе держит запечатанную копию набора для восстановления этого сервера, которую сам открыть не может. Открывает её только код восстановления из 20 символов, и хранитель выдаёт её, лишь когда кто-нибудь у него нажмёт Разрешить. См. Хранитель ключа.

Узлы

Узел это BombVault без веб-интерфейса, который получает команды от домашнего экземпляра.

  • Домашний экземпляр держит узел. Узел монтирует сокет Docker своего сервера, а это там права root, и домашний экземпляр управляет узлом. Если домашний экземпляр захвачен, злоумышленник управляет и всеми его узлами. Задайте домашнему экземпляру пароль для входа и не выставляйте его веб-интерфейс в интернет.
  • У узла мало что есть. Если узел захвачен, злоумышленник не получает ни группу сопряжения, ни крепость, ни другой узел, ни другой репозиторий. У узла есть только канал к своему домашнему экземпляру, собственный логин на принимающем сервере и собственная папка в месте назначения. На принимающем сервере он не может удалить историю, потому что сервер работает в режиме append-only. Он может заполнить диск сервера, потому что rest-server не ставит квот, поэтому дайте принимающему серверу запас места или отдельный общий ресурс. В месте назначения его учётные данные обычно позволяют удалить то, что там лежит. Копии, которые хранятся на узле, оказываются в руках злоумышленника, поэтому домашний экземпляр подтягивает их копию.
  • Канал закрытый и подписанный. Домашний экземпляр и узел общаются через Relay по собственному каналу, запечатанному секретом, выведенным из APP_KEY узла. Каждая сторона знает ключ другой ещё до первого вызова, поэтому шага одобрения нет. Домашний экземпляр подписывает каждый вызов своим ключом и счётчиком, а узел отклоняет вызов, который подписал не домашний экземпляр или который он уже принимал. Узел не вызывает на домашнем экземпляре ничего, кроме своего приветствия.
  • Домашний экземпляр достаёт до фиксированного списка. Запросы, которые домашний экземпляр передаёт узлу, работают только на фиксированном списке маршрутов узла, перечисленных в GET /api/nodes/routes, и узел отвечает на них только в JSON. Ничто в этом списке не удаляет и не достаёт до настроек, хранилища, ключей, группы или токенов. На домашнем экземпляре для них нужен вход с паролем: сопряжённые телефоны, токены API и ключи MCP до узла не достают. Копии и восстановления, запущенные так, помечены как запущенные домашним экземпляром.
  • Депозиты ключей несут ключи узлов. Домашний экземпляр хранит APP_KEY каждого узла, а набор для восстановления печатает его в главе Узлы, поэтому его несёт и депозит ключа. Хранитель ключа, получивший депозит и код восстановления, может открыть репозитории ваших узлов, но не может командовать узлом, потому что для этого нужна подпись домашнего экземпляра.
  • Отвязка навсегда. Отвязанный узел больше не примет никакой домашний экземпляр с тем же APP_KEY. Узел, которого нет на месте, когда вы его отвязываете, узнает об этом от домашнего экземпляра, когда вернётся.

Сеть

  • Изменения требуют JSON. Запрос, который что-то меняет, должен отправлять Content-Type: application/json и не должен быть помечен браузером как межсайтовый, так что страница на другом сайте не может заставить ваш браузер менять настройки по адресу в локальной сети. Скрипт, управляющий API, отправляет этот заголовок. Всё остальное отклоняется с 415.
  • Поскольку защита включается по желанию, пока она не задана, весь интерфейс и API (включая места назначения, маршруты теста на подделку и маршруты восстановления) доступны каждому, кто достаёт до порта. Задайте пароль для входа, как только используются внешние копии append-only или шифрование.
  • Запускайте BombVault только в доверенной сети, недоступной снаружи. Для удалённого доступа поставьте его за обратный прокси, который добавляет аутентификацию и TLS. Ответы несут базовые заголовки безопасности (CSP, nosniff, X-Frame-Options, Referrer-Policy).
  • За обратным прокси каждый запрос несёт адрес прокси, поэтому без TRUSTED_PROXY ограничитель входа считает всех клиентов в одной корзине, и неудачи злоумышленника блокируют и вас. Назовите прокси в TRUSTED_PROXY, чтобы вернуть подсчёт по клиентам.
  • Обратный прокси перед BombVault должен пропускать заголовок Authorization или X-API-Key к /mcp и не должен буферизовать его ответы, иначе помощники не смогут подключиться. См. Сервер MCP.
  • Конечная точка MCP /mcp отвечает 404, пока не появится ключ или не включён вход через OAuth, и просит у каждого клиента ключ или токен даже при выключенном пароле для входа. Ни один адрес не исключён, даже localhost. В ней нет инструментов восстановления и удаления, а восстановление копии конфигурации отзывает все ключи. См. Сервер MCP.
  • При HTTP_ONLY=true cookie сеанса теряет флаг Secure (иначе по обычному HTTP она не работала бы), поэтому включайте пароль за прокси, завершающим TLS, только если важна конфиденциальность.
  • SSH-соединение для копий виртуальных машин доверяет ключу хоста при первом подключении (TOFU) и затем закрепляет его. Проверьте ключ хоста другим путём, если путь от контейнера до хоста не доверенный.
  • Ссылки не выводят за пределы монтирования. Копия или восстановление на месте останавливается с сообщением, если ссылка выше его пути ведёт за пределы монтирования хоста, потому что контейнер, который пишет в собственный общий ресурс, мог бы её подложить. Место назначения, у которого хост или remote rclone начинается с дефиса, отклоняется так же, при сохранении и при следующем запуске, потому что ssh или rclone прочли бы его как параметр.

Сервер MCP

Серверу MCP не нужна переменная окружения. Вы включаете его, создав ключ в Настройки, Интеграции, Сервер MCP, и он отвечает по адресу /mcp на том же порту, что и веб-интерфейс (например https://192.168.1.10:3443/mcp). Без активного ключа этот путь отвечает 404. Клиенты, сертификаты и ограничения описаны на странице Сервер MCP.

Копирование виртуальных машин по SSH

BombVault копирует виртуальные машины KVM/libvirt без монтирования какого-либо пути libvirt. Он запускает virsh на хосте по SSH (qemu+ssh://), поэтому никогда не может повлиять на VM Manager вашего хоста.

Монтировать сокет libvirt хоста в контейнер в Unraid хрупко: эти пути принадлежат VM Manager, а переключение «Enable VMs» может оставить libvirt неспособным запуститься. Ключ SSH даёт root на хосте, тот же уровень доверия, что и сокет Docker, который BombVault уже использует.

Быстрая настройка:

  1. Настройки, Интеграции, SSH хоста: скопируйте показанный открытый ключ.
  2. Добавьте его в /root/.ssh/authorized_keys в Unraid (также сохраняется на флешку, чтобы пережить перезагрузки).
  3. Нажмите Проверить соединение.

Шаблон добавляет --add-host=host.docker.internal:host-gateway, чтобы контейнер мог достать до хоста. Задайте LIBVIRT_HOST равным IP вашего Unraid в локальной сети, если это имя не разрешается (например когда контейнер работает в пользовательской сети br0.x). Если вы изменили порт SSH в Unraid, задайте LIBVIRT_SSH_PORT соответственно. Для живых снимков нужны ещё гостевой агент qemu в виртуальной машине и диск на /mnt/cache (не на /mnt/user).

Полное руководство по настройке виртуальных машин и сети

Полное пошаговое руководство (включение SSH, постоянная авторизация ключа, маршрутизация для пользовательской сети и VLAN, метод для отдельной виртуальной машины и устранение неполадок на стороне хоста) — это руководство по копированию виртуальных машин.

Настройка внешних копий

Внешние копии идут в места назначения. Откройте Места назначения с её плитки настроек (или закрепите в боковой панели) и выберите Добавить место назначения. Полный порядок работы (защита от удаления, тест на подделку и DR-проверки) см. в разделе Внешние копии и восстановление. Вкратце:

  • Бэкенды: SMB/CIFS и WebDAV через rclone без монтирования на хосте, NFS (смонтируйте экспорт на хосте и используйте его как локальную папку), собственные бэкенды restic без rclone (s3:..., rest:http://host:8000/repo, sftp:user@host:/repo) или любой удалённый ресурс rclone (rclone:<remote>:<bucket>/path). У Backblaze B2 здесь нет собственного бэкенда: обращайтесь к нему через его конечную точку S3 (s3:https://s3.<region>.backblazeb2.com/<bucket>/<path>), указав ID ключа и ключ приложения как учётные данные S3.
  • Учётные данные хранятся зашифрованными одним списком сохранённых учётных данных в карточке Учётные данные в Настройки, Места назначения. Звёздочка отмечает значение по умолчанию, которое используется везде, где ничего не выбрано. Страница самого места выбирает, какие использовать, в своей карточке Учётные данные. См. Учётные данные.
  • Целям SSH на дальней стороне ничего устанавливать не нужно. Для sftp: нужен только сервер SSH. Добавьте открытый ключ из Настройки, Интеграции, SSH хоста (он также лежит в /config/ssh/id_ed25519.pub) в ~/.ssh/authorized_keys целевого пользователя или позвольте Добавить ключ в Добавить место назначения положить его туда с паролем учётной записи.
  • rest-server с самоподписанным сертификатом: положите его сертификат или сертификат центра, который его подписал, как файл PEM в папку certs в папке данных BombVault (/config/certs в контейнере, appdata/bombvault/certs в Unraid). Копии, копирование и тест защиты от удаления доверяют ему без перезапуска.
  • Внешняя копия: BombVault копирует новые снимки через restic copy по возможности, поверх (обычно локального) основного. Карточка Копировать места задаёт, копирует ли оно После каждой копии или по собственному плану, а Настройки, Расписание, Внешние копии по разделам даёт одному разделу собственный план копирования. Реплицировать сейчас стоит в строке раздела карточки Внешние копии в Настройки, Места назначения.
  • Несколько мест назначения для раздела: карточка Места назначения по разделам на странице мест назначения включает и выключает каждую линию от раздела к месту одним щелчком, Локально тоже. Раздел только с внешними местами копирует прямо в них, а раздел со всеми выключенными линиями не копируется. Правила по разделам места дают одному разделу там собственный репозиторий, хранение или сжатие.
  • Размещение для отдельной записи: каждый контейнер, виртуальная машина и набор папок подсвечивает Локально и места, которые получают его копии, в карточке Расписание и место назначения на его вкладке «Настройки». Записи без собственного выбора следуют своему разделу. См. Размещение для отдельной записи.
  • Хранение: каждое место назначения хранит копии по своей карточке Как долго хранить, а раздел может держать там собственные значения в Правила по разделам. Это относится и к копии в поле внешнего хранения раздела. Все нули никогда не обрезают снимки места.
  • Ограничения полосы: ограничьте скорость отдачи и загрузки restic в карточке Внешняя пропускная способность в Настройки, Места назначения или для каждого места в его карточке Копировать. Вы вводите KiB/s, а поле показывает ту же скорость в МБ/с и Мбит/с.
  • Сначала трансляция: в карточке Стриминг на странице мест назначения выберите медиасерверы (Plex, Jellyfin и Emby выбраны заранее по имени образа), скорость отправки, с которой считается, что идёт трансляция, лимит отдачи во время трансляции и как скоро после трансляции возвращается обычный лимит.
  • Холодный и архивный класс хранения (S3): для места назначения S3 выберите на его странице уровень, из которого можно восстановить (Standard, Standard-IA, One Zone-IA, Intelligent-Tiering, Glacier Instant Retrieval). Удалённые ресурсы rclone задают свой класс в конфигурации rclone.
  • Собственная папка в месте назначения вместо локальной: собственная папка раздела может лежать в одном из мест назначения выше, без локальной копии и без шага копирования. См. Собственная папка раздела.

Аномалии

Обнаружению аномалий не нужна переменная окружения. Оно настраивается в карточке Аномалии в Настройки, Проверка и описано на странице Аномалии.

Переносимые настройки (экспорт и импорт)

Карточка Экспорт / импорт настроек в Настройки, Система записывает всю вашу конфигурацию BombVault (настройки разделов, места назначения, расписания, хранение, уведомления) в переносимый файл JSON, который можно импортировать на другом экземпляре, так что переезд на новый сервер или клонирование настройки не означает ввода всего заново вручную. Импорт показывает предпросмотр и просит подтверждения и никогда не трогает данные ваших копий или историю. Ссылки в файле на места назначения или репозитории, которых больше нет, пропускаются, а предпросмотр их называет. Пока идёт реплика ZFS, импорт отклоняется, прежде чем что-либо записано.

Экспорт может содержать учётные данные

Вы сами выбираете, включать ли в файл учётные данные внешних копий, уведомлений и брокера MQTT. С включёнными учётными данными экспорт так же чувствителен, как ваш набор для восстановления, так что храните его в надёжном месте. Без них файл содержит только несекретные настройки.

APP_KEY не переезжает вместе с файлом

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