設定實例
每個 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 不需要登入:它會傳回呼叫者所見的品牌設定和開關,這也是控制台載入時讀取的內容。