配置实例
每个 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、托管实例和 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 不需要登录:它返回调用方看到的品牌设置和开关,这正是控制台在加载时读取的内容。