Переменные среды
Excubius считывает параметры установки из файла .env в каталоге установки — по умолчанию /opt/excubius/.env с режимом 0600, владелец — служебная учетная запись. Установщик записывает этот файл на основе ваших ответов и один раз создает секреты. В этом справочнике перечислены ключи, которые можно задать, сгруппированные как в файле.
Большинство параметров находится в консоли, а не здесь: фирменное оформление и переключатели функций — в Settings › Instance, имена и сертификаты — в Settings › Server, источники — в Settings › Sources, учетные данные для мониторинга — в Settings › Credentials. После изменения файла перезапустите платформу от имени служебной учетной записи командой systemctl --user restart excubius.
Создайте резервную копию файла .env, а вместе с ним и EXCUBIUS_DATA_KEY. Без этого ключа секреты, хранящиеся в базе данных, невозможно расшифровать.
Установка
| Ключ | По умолчанию | Значение |
|---|---|---|
EXCUBIUS_HOME | /opt/excubius | Каталог установки. Записывается установщиком |
SERVER_NAME | — | Основное имя: узел общедоступного URL-адреса |
REGISTRY | ghcr.io/custorius-labs/excubius | Префикс реестра и репозитория образов |
PROXY_MODE | http | http или https. Действует, только пока управление не перешло к службе сертификатов; после этого решает Settings › Server |
COOKIE_SECURE | пусто | Пусто: файлы cookie сеанса получают атрибут Secure, если запрос пришел по HTTPS. true или false задают его принудительно. Оставьте пустым |
Имена и TLS
Эти ключи задают начальные параметры TLS только при первом запуске, когда у платформы их еще нет. После этого имена и сертификаты управляются в Settings › Server без перезапуска. Установщик удаляет из файла учетные данные DNS и закрытый ключ, как только платформа их сохранит.
| Ключ | По умолчанию | Значение |
|---|---|---|
TLS_MODE | пусто | letsencrypt_http, letsencrypt_dns, selfsigned, custom, gateway или http. Также принимаются имена установщика letsencrypt, letsencrypt-dns и later |
TLS_ALIASES | пусто | Другие имена, которые могут открывать пользователи, через пробел |
TLS_CERT_NAMES | пусто | Имена для сертификата через пробел. Пусто: все имена |
TLS_EMAIL | пусто | Адрес электронной почты учетной записи Let's Encrypt |
TLS_ACME_SERVER | production | staging — для репетиции с тестовыми сертификатами, которым браузеры не доверяют |
TLS_DNS_PROVIDER | пусто | Идентификатор dnsapi в acme.sh для поставщика DNS, например dns_cf или dns_azure |
TLS_DNS_CREDENTIALS | пусто | Пары KEY=VALUE, разделенные переводами строк или ;, либо base64:<…> |
TLS_CERT_FILE, TLS_KEY_FILE | пусто | base64:<PEM contents> вашей цепочки сертификатов и закрытого ключа |
TLS_ACME_DNSSLEEP | 0 | Сколько секунд ждать распространения DNS вместо проверки через общедоступные сопоставители DNS-over-HTTPS. Используйте в сетях, из которых они недоступны |
Продукт
| Ключ | По умолчанию | Значение |
|---|---|---|
PRODUCT_NAME | Excubius | Только резервное значение. Название продукта берется из фирменного оформления в Settings › Instance |
DEFAULT_LOCALE | en | Язык по умолчанию |
BASE_URL | — | Общедоступный URL-адрес, например https://monitoring.example.com. Его используют ссылки в сообщениях |
EXCUBIUS_DEFAULT_PRESET | enterprise | Предустановка, с которой запускается экземпляр: enterprise, databases или core |
EXCUBIUS_FEATURES_ENFORCE_API | false | true: отключенные функции также отклоняются API. По умолчанию они только скрываются в интерфейсе |
База данных и секреты
| Ключ | По умолчанию | Значение |
|---|---|---|
POSTGRES_USER | excubius | Пользователь базы данных |
POSTGRES_PASSWORD | создается | Только буквы и цифры, потому что пароль встраивается в URL-адрес подключения |
POSTGRES_DB | excubius | Имя базы данных |
DATABASE_URL | строится из трех ключей выше | URL-адрес подключения. Контейнеры получают его построенным из трех ключей выше |
EXCUBIUS_DATA_KEY | создается | Ключ, которым шифруются секреты в базе данных: учетные данные, секреты источников, ключи API DNS. 32 случайных байта в URL-безопасном base64. Никогда не меняйте его в работающей установке |
EXCUBIUS_COLLECTOR_TOKEN | создается | Общий секрет сборщика и API. Пусто: сборщик простаивает, а конечные точки сборщика отключены |
Вход
| Ключ | По умолчанию | Значение |
|---|---|---|
JWT_SECRET | создается | Подписывает токены сеанса. 64 случайных символа |
ACCESS_TOKEN_MINUTES | 15 | Время жизни токена доступа |
REFRESH_TOKEN_DAYS | 14 | Время жизни сеанса |
ENTRA_TENANT_ID, ENTRA_CLIENT_ID, ENTRA_CLIENT_SECRET | пусто | Вход через Microsoft Entra ID с одним клиентом: идентификатор каталога, а не common или organizations. Предлагается, когда заданы все три ключа. URI перенаправления: <BASE_URL>/api/v1/auth/entra/callback |
GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET | пусто | Вход через Google. URI перенаправления: <BASE_URL>/api/v1/auth/google/callback |
ALLOWED_SIGNUP_DOMAINS | пусто | Домены электронной почты через запятую; пользователи из них при первом входе получают учетную запись с ролью наблюдателя в корне. Действует, только пока в корневой сущности не сохранен режим регистрации. Пусто: только по приглашению |
Секреты клиентов никогда не хранятся в базе данных и не записываются в журналы.
Ядро мониторинга
| Ключ | По умолчанию | Значение |
|---|---|---|
EXCUBIUS_UNREACHABLE_AFTER | 3 | Число последовательных сбоев подключения, входа или по времени ожидания, после которого ресурс получает оповещение Cannot reach |
EXCUBIUS_NOTIFY_QUIET_MINUTES | 10 | Минимальный интервал в минутах между двумя сообщениями об одном и том же условии. Сообщение о росте серьезности отправляется всегда |
EXCUBIUS_COLLECTOR_VIA_PROXY | false | true только для сборщика вне сервера, который обращается к API через общедоступный адрес |
Сборщик
Контейнер сборщика получает только эти ключи, а не весь файл.
| Ключ | По умолчанию | Значение |
|---|---|---|
EXCUBIUS_COLLECTOR_TOKEN | создается | См. раздел База данных и секреты |
EXCUBIUS_COLLECTOR_TRANSPORTS | все имеющиеся транспорты | Подмножество для предоставления через запятую, например tsql,http,dns. Значения: tsql, http, dns, winrm, ssh, azure_graph, defender, entra, wazuh |
EXCUBIUS_COLLECTOR_CONCURRENCY | 32 | Число одновременно выполняемых проверок |
EXCUBIUS_TSQL_THREADS | 16 | Потоки для подключений к SQL Server |
EXCUBIUS_SQL_APP_NAME | monitoring-collector | Имя приложения для сеансов SQL Server сборщика |
EXCUBIUS_ODBC_DRIVER | ODBC Driver 18 for SQL Server | Имя драйвера ODBC |
AZURE_SUBSCRIPTION_IDS | пусто | Подписки через запятую для собственных проверок Resource Graph (безопасность облака, Azure Update Manager), если учетные данные их не задают. Пусто: все подписки, которые может читать удостоверение. У источника Azure Monitor свой список |
AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET | пусто | Пусто: управляемое удостоверение сервера. Только AZURE_CLIENT_ID указывает на назначаемое пользователем управляемое удостоверение. Все три: вместо него используется этот субъект-служба |
У сборщика есть также параметры интервалов опроса, размеров пакетов и буфера и имени узла, но установленная платформа не передает их в его контейнер, поэтому действуют значения по умолчанию: назначения каждые 30 секунд, задания каждые 10 секунд, пульс каждые 60 секунд, 200 результатов в пакете, 10 000 результатов хранится, пока API недоступен.
Уведомления и заявки
| Ключ | По умолчанию | Значение |
|---|---|---|
SLACK_BOT_TOKEN | пусто | Токен бота приложения Slack с областью chat:write. Пусто: в Slack ничего не отправляется |
SLACK_DEFAULT_CHANNEL | #alerts | Получает предупреждения и критические оповещения, если ни у одной сущности на пути нет канала |
JIRA_BASE_URL | пусто | https://<site>.atlassian.net |
JIRA_AUTH | token | token (адрес электронной почты и токен API), oauth (учетные данные клиента служебной учетной записи Atlassian) или bearer |
JIRA_EMAIL, JIRA_API_TOKEN | пусто | Учетные данные для token |
JIRA_OAUTH_CLIENT_ID, JIRA_OAUTH_CLIENT_SECRET | пусто | Учетные данные для oauth |
JIRA_CLOUD_ID | пусто | Только для oauth: облачный идентификатор сайта |
JIRA_OAUTH_TOKEN_URL | https://auth.atlassian.com/oauth/token | URL-адрес токена для oauth |
JIRA_DEFAULT_PROJECT | пусто | Ключ проекта для новых задач |
JIRA_ISSUE_TYPE | Task | Имя типа задачи в этом проекте |
JIRA_SYNC_MINUTES | 10 | Как часто считывается статус открытых задач |
WEB_PUSH_VAPID_PUBLIC, WEB_PUSH_VAPID_PRIVATE | пусто | Зарезервировано для веб-push-уведомлений, недоступных в этом выпуске. Оставьте пустыми |
Ключи Jira — это значения по умолчанию: каждая сущность может переопределить их в собственных параметрах Jira. См. статью Создание задач Jira из оповещений.
Обработчик обновлений и безопасности
| Ключ | По умолчанию | Значение |
|---|---|---|
EXCUBIUS_SECURITY_WORKER | true | Фоновый обработчик API: каналы поставщиков, истечение принятия рисков, проверки, выполняемые API, снимки оценки безопасности, статус Jira. Задавайте false только на дополнительных репликах API |
EXCUBIUS_FEEDS_ENABLED | true | false: никогда не загружать каналы поставщиков — для изолированных установок. Используются копии, поставляемые с выпуском |
EXCUBIUS_FEED_TIMEOUT_SECONDS | 60 | Время ожидания для каждого запроса к каналу |
EXCUBIUS_FEED_SQLSERVER_BUILDS_URLS | сайт dbatools, затем GitHub | URL-адреса списка сборок SQL Server через пробел, перебираются по порядку. Поставьте внутреннее зеркало первым |
EXCUBIUS_FEED_ENDOFLIFE_URL | https://endoflife.date/api | Базовый URL-адрес канала окончания поддержки |
EXCUBIUS_FEED_MSRC_URL | https://api.msrc.microsoft.com/cvrf/v3.0 | Базовый URL-адрес бюллетеней безопасности Майкрософт |
EXCUBIUS_FEED_MSRC_MONTHS | 3 | Число ежемесячных выпусков, которые поддерживаются в актуальном состоянии, от 1 до 24 |
HTTPS_PROXY | пусто | Прокси-сервер для запросов к каналам |
Ключи, которые этот выпуск не считывает
Поставляемый файл .env.example все еще содержит NEWRELIC_API_KEY, NEWRELIC_ACCOUNT_ID, NEWRELIC_WEBHOOK_SECRET, NINJAONE_CLIENT_ID, NINJAONE_CLIENT_SECRET, NINJAONE_REGION, WAZUH_API_URL, WAZUH_API_USER и WAZUH_API_PASSWORD. Этот выпуск их игнорирует. Настройте New Relic и NinjaOne в Settings › Sources, а Wazuh — с помощью учетных данных и параметров проверки; см. статьи Источники и Безопасность облака.