Настройка экземпляра
Каждая установка Excubius поставляется со всеми возможностями. Раздел Settings › Instance определяет, какие из них показывает установка и под каким названием, логотипом и темой. Изменения сразу применяются для всех и записываются в журнал аудита. В этом руководстве показано, как переключать функции, применять предустановку и настраивать фирменное оформление.
Перед началом работы
- Вам нужна роль Super admin (суперадминистратор). Другим пользователям этот экран не отображается.
- Некоторым функциям также требуется настройка на сервере, например токен Slack или учетные данные Jira. Включение функции делает ее видимой, но не настраивает ее.
Открытие экрана
- Выберите Settings, затем Instance.
- Найдите разделы Presets, Features и Branding, описанные ниже. В нижней части экрана указано, скрываются ли отключенные функции только визуально или также отклоняются API, и когда было внесено последнее изменение.
Для имен сервера и TLS есть отдельный экран, ссылка на который находится вверху: Server names and HTTPS. См. статью Настройка имен и TLS.
Начало работы с предустановки
Предустановка — это именованная отправная точка: набор переключателей функций и фирменное оформление. Каждая предустановка отображается в виде карточки с описанием. Предустановки общего назначения:
| Предустановка | Содержимое |
|---|---|
enterprise | Все включено; используется по умолчанию для новой установки |
databases | Инфраструктура, оповещения, страница состояния и модули баз данных |
core | Инфраструктура, оповещения и страница состояния |
Выбор карточки предустановки сразу применяет ее. Она заменяет все переключатели функций и фирменное оформление значениями из предустановки. Перед применением запишите свои параметры фирменного оформления, а после него настройте отдельные переключатели.
Даже в предустановке enterprise источники Defender for Cloud и Wazuh остаются отключенными, пока вы их не включите.
Включение и отключение функции
- В разделе Features найдите функцию в ее группе: Sources, Monitoring, Security, Collaboration, Access или Interface. В каждой строке показаны ключ функции, ее назначение и, если есть, функция, от которой она зависит.
- Используйте ее переключатель.
Изменение применяется сразу.
- Функция, зависящая от другой функции, неактивна, пока та отключена. Отключение обязательной функции отключает и зависящие от нее функции; например, отключение
securityтакже отключаетsecurity.defenderиsecurity.wazuh. - Отключение функции, которой принадлежат модули каталога, удаляет эти модули из списка каталога.
- По умолчанию скрытие носит только визуальный характер: навигация, экраны и мини-приложения следуют переключателям, а сбор, хранение данных и API продолжают работать. Когда вы снова включаете функцию, ее история сохраняется. Чтобы API также отклонял отключенные функции, задайте
EXCUBIUS_FEATURES_ENFORCE_API=trueв конфигурации сервера; тогда их конечные точки будут отвечать404. - Некоторые переключатели применяются принудительно в любом случае. Если
access.google_loginотключена, вход через Google отклоняется.
Функции, на которые ссылаются другие руководства:
| Функция | Чем она управляет |
|---|---|
monitoring.databases | Модули SQL Server (включая группы доступности), Azure SQL, Managed Instance и PostgreSQL |
monitoring.updates | Страница Updates & advisories и ее проверки |
security | Страница Security posture, замечания и оценка безопасности |
security.defender, security.wazuh | Сбор данных из Microsoft Defender for Cloud и из Wazuh. По умолчанию отключены |
security.recommendations | Показывает рекомендации Defender for Cloud рядом с замечаниями |
collab.jira | Create Jira ticket для оповещений и замечаний; требует collab.assign |
access.google_login | Вход через Google |
access.directory_groups | Роли для групп Microsoft Entra ID |
ui.public_status_page | Общедоступные страницы состояния |
ui.i18n | Языки, кроме английского, в консоли и в сообщениях Slack |
ui.themes | Цветовые темы помимо светлой и темной |
Настройка фирменного оформления
-
В разделе Branding заполните поля:
Поле Действие Product name Заголовок браузера, шапка, страница входа, имя установленного приложения, а также префикс и метка задач Jira. Не более 60 символов Tagline Отображается рядом с названием на широких экранах и в описании установленного приложения. Не более 120 символов Logo None, Built-in mark или Image URL: адрес httpsили путь на этом сервере, начинающийся с/Default theme Тема страницы входа и новых пользователей. Пользователи по-прежнему могут выбрать собственную Show "powered by" line Строка с указанием авторства в нижнем колонтитуле, отображается только со встроенным знаком -
Выберите Save.
Если для Logo задано значение None, везде используется нейтральный значок, в том числе на вкладке браузера и в установленном приложении, поэтому ничто в браузере не называет продукт. Сообщения Slack и общедоступные страницы состояния никогда не называют продукт, независимо от фирменного оформления.
Доступны темы Midnight, Daylight, Slate and amber, Ops room (high contrast), Okabe–Ito (colour-blind safe) и Paper. Если ui.themes отключена, установка предлагает только светлую и темную темы.
У ветви клиента могут быть собственные тема и логотип по умолчанию; см. раздел Настройка оформления ветви.
Выполнение через API
Для каждого запроса нужна роль Super admin, и каждый запрос проходит аудит.
| Задача | Запрос |
|---|---|
| Чтение полной конфигурации, предустановок и реестра функций | GET /api/v1/instance/admin |
| Применение предустановки | POST /api/v1/instance/preset с {"name": "databases"} |
| Переключение функций | PATCH /api/v1/instance/features с {"changes": {"collab.jira": false}} |
| Изменение фирменного оформления | PATCH /api/v1/instance/branding с любыми из product_name, tagline, logo, show_powered_by, theme_default |
GET /api/v1/instance не требует входа: возвращает фирменное оформление и переключатели в том виде, в каком их видит вызывающая сторона. Именно эти данные консоль считывает при загрузке.