環境變數
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 | 空白 | 空白:只要要求是透過 HTTPS 送達,工作階段 Cookie 就會是 Secure。true 或 false 可強制設定。請保持空白 |
名稱和 TLS
這些鍵只會在首次啟動、且平台尚未有任何 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 | 空白 | DNS 供應商的 acme.sh dnsapi ID,例如 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 | 實例起始所用的預設(preset):enterprise、databases 或 core |
EXCUBIUS_FEATURES_ENFORCE_API | false | true:已關閉的功能也會被 API 拒絕。預設:只在介面中隱藏 |
數據庫和機密
| 鍵 | 預設值 | 含義 |
|---|---|---|
POSTGRES_USER | excubius | 數據庫用戶 |
POSTGRES_PASSWORD | 自動產生 | 只包含字母和數字,因為它會嵌入連線 URL 中 |
POSTGRES_DB | excubius | 數據庫名稱 |
DATABASE_URL | 由上述三項組成 | 連線 URL。容器收到的是由上述三個鍵組成的 URL |
EXCUBIUS_DATA_KEY | 自動產生 | 加密數據庫中所儲存機密的金鑰:憑證、數據源機密、DNS API 金鑰。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 登入,單一租戶:使用目錄 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 | 只有在伺服器以外的採集器透過公開位址連線到 API 時,才設為 true |
採集器
採集器容器只會收到這些鍵,不會收到整個檔案。
| 鍵 | 預設值 | 含義 |
|---|---|---|
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 個結果,API 無法連線期間保留 10,000 個結果。
通知和工單
| 鍵 | 預設值 | 含義 |
|---|---|---|
SLACK_BOT_TOKEN | 空白 | Slack 應用程式的 bot 權杖,具備範圍 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:網站的 cloud ID |
JIRA_OAUTH_TOKEN_URL | https://auth.atlassian.com/oauth/token | oauth 的權杖 URL |
JIRA_DEFAULT_PROJECT | 空白 | 新問題所屬的專案鍵 |
JIRA_ISSUE_TYPE | Task | 該專案中的問題類型名稱 |
JIRA_SYNC_MINUTES | 10 | 讀取未完成問題狀態的頻率(分鐘) |
WEB_PUSH_VAPID_PUBLIC、WEB_PUSH_VAPID_PRIVATE | 空白 | 保留給網頁推送通知使用,此版本尚未提供。請保持空白 |
Jira 鍵是預設值:每個實體都可以在自己的 Jira 設定中覆蓋這些值。請參閱從警報建立 Jira 問題。
更新和安全工作程序
| 鍵 | 預設值 | 含義 |
|---|---|---|
EXCUBIUS_SECURITY_WORKER | true | API 的背景工作程序:供應商訂閱源、風險接受到期、由 API 執行的檢查、安全分數快照、Jira 狀態。只有在額外的 API 複本上才設為 false |
EXCUBIUS_FEEDS_ENABLED | true | false:絕不擷取供應商訂閱源,適用於與外部網絡隔絕的安裝。此時會使用隨版本附帶的副本 |
EXCUBIUS_FEED_TIMEOUT_SECONDS | 60 | 每個訂閱源要求的逾時時間 |
EXCUBIUS_FEED_SQLSERVER_BUILDS_URLS | dbatools 網站,然後是 GitHub | SQL Server 組建清單的 URL,以空格分隔,按順序嘗試。請將內部鏡像放在最前面 |
EXCUBIUS_FEED_ENDOFLIFE_URL | https://endoflife.date/api | 支援結束訂閱源的基本 URL |
EXCUBIUS_FEED_MSRC_URL | https://api.msrc.microsoft.com/cvrf/v3.0 | Microsoft 安全公告的基本 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。此版本會忽略這些鍵。請在 Settings › Sources 中設定 New Relic 和 NinjaOne,並透過憑證和檢查的參數設定 Wazuh;請參閱數據源和雲端安全。