环境变量
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 | 实例起始所用的预设: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 应用的机器人令牌,作用域为 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:站点的云 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 | 空 | 为 Web 推送通知保留,此版本不可用。请保持为空 |
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;请参阅数据源和云安全。