配置

Trilium 支持通过名为 和 环境变量的文件进行配置。本文档为所有配置选项提供了全面的参考。config.ini

配置文件的位置

配置文件与应用程序不在同一目录中。相反,位于 [missing note]中。因此,配置文件仅在启动应用程序并创建数据库后才可用。config.ini

配置优先级

配置值按以下优先级顺序加载(从高到低):

  1. 环境变量(首先检查)

  2. config.ini文件值

  3. 默认值

环境变量模式

Trilium 支持多种环境变量模式以实现灵活性。主要模式是:TRILIUM_[SECTION]_[KEY]

哪里:

  • SECTION是大写的 INI 部分名称

  • KEY是将驼峰命名法配置键转换为大写(例如,→instanceNameINSTANCENAME)

此外,对于常见配置,可以使用较短的别名(请参阅下面的替代变量部分)。

环境变量参考

一般部分

环境变量类型违约描述
TRILIUM_GENERAL_INSTANCENAME字符串""API 标识的实例名称
TRILIUM_GENERAL_NOAUTHENTICATION布尔禁用身份验证(仅限服务器)
TRILIUM_GENERAL_NOBACKUP布尔禁用自动备份
TRILIUM_GENERAL_NODESKTOPICON布尔禁用桌面图标创建
TRILIUM_GENERAL_READONLY布尔启用只读模式

网络部分

环境变量类型违约描述
TRILIUM_NETWORK_HOST字符串"0.0.0.0"服务器主机绑定
TRILIUM_NETWORK_PORT字符串"3000"服务器端口
TRILIUM_NETWORK_HTTPS布尔启用 HTTPS
TRILIUM_NETWORK_CERTPATH字符串""SSL 证书路径
TRILIUM_NETWORK_KEYPATH字符串""SSL 密钥路径
TRILIUM_NETWORK_TRUSTEDREVERSEPROXY布尔值/字符串反向代理信任设置
TRILIUM_NETWORK_CORSALLOWORIGIN字符串""CORS 允许的源
TRILIUM_NETWORK_CORSALLOWMETHODS字符串""CORS 允许的方法
TRILIUM_NETWORK_CORSALLOWHEADERS字符串""CORS 允许的标头

会话部分

环境变量类型违约描述
TRILIUM_SESSION_COOKIEMAXAGE整数1814400会话 Cookie 最大期限(以秒为单位)(21 天)

同步部分

环境变量类型违约描述
TRILIUM_SYNC_SYNCSERVERHOST字符串""同步服务器主机 URL
TRILIUM_SYNC_SYNCSERVERTIMEOUT字符串"120000"同步服务器超时(以毫秒为单位)
TRILIUM_SYNC_SYNCPROXY字符串""同步代理 URL

MultiFactorAuthentication 部分

环境变量类型违约描述
TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL字符串""OAuth/OpenID 基本 URL
TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID字符串""OAuth 客户端 ID
TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET字符串""OAuth 秘密客户端
TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL字符串"https://accounts.google.com"OAuth 颁发者基本 URL
TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME字符串“谷歌”OAuth 颁发者显示名称
TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON字符串""OAuth 颁发者图标 URL

日志记录部分

环境变量类型违约描述
TRILIUM_LOGGING_RETENTIONDAYS整数90保留日志文件的天数

替代环境变量

还支持以下替代环境变量名称,其工作方式与较长的对应项相同:

网络 CORS 变量

  • TRILIUM_NETWORK_CORS_ALLOW_ORIGIN(替代TRILIUM_NETWORK_CORSALLOWORIGIN)

  • TRILIUM_NETWORK_CORS_ALLOW_METHODS(替代TRILIUM_NETWORK_CORSALLOWMETHODS)

  • TRILIUM_NETWORK_CORS_ALLOW_HEADERS(替代TRILIUM_NETWORK_CORSALLOWHEADERS)

同步变量

  • TRILIUM_SYNC_SERVER_HOST(替代TRILIUM_SYNC_SYNCSERVERHOST)

  • TRILIUM_SYNC_SERVER_TIMEOUT(替代TRILIUM_SYNC_SYNCSERVERTIMEOUT)

  • TRILIUM_SYNC_SERVER_PROXY(替代TRILIUM_SYNC_SYNCPROXY)

OAuth/MFA 变量

  • TRILIUM_OAUTH_BASE_URL(替代TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL)

  • TRILIUM_OAUTH_CLIENT_ID(替代TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID)

  • TRILIUM_OAUTH_CLIENT_SECRET(替代TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET)

  • TRILIUM_OAUTH_ISSUER_BASE_URL(替代TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL)

  • TRILIUM_OAUTH_ISSUER_NAME(替代TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME)

  • TRILIUM_OAUTH_ISSUER_ICON(替代TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON)

记录变量

  • TRILIUM_LOGGING_RETENTION_DAYS(替代TRILIUM_LOGGING_RETENTIONDAYS)

布尔值

布尔环境变量接受以下值:

  • 正确: , ,"true""1"1

  • 错误: , ,"false""0"0

  • 任何其他值默认为false

使用环境变量

这两种命名模式都完全受支持,可以互换使用:

  • 较长的格式遵循节/键模式,以与 INI 文件结构保持一致

  • 较短的替代方案为常见配置提供了便利

  • 您可以使用您喜欢的任何格式 - 两者都同样有效

例子

Docker Compose 示例

services:
  trilium:
    image: triliumnext/notes
    environment:
      # Using full format
      TRILIUM_GENERAL_INSTANCENAME: "My Trilium Instance"
      TRILIUM_NETWORK_PORT: "8080"
      TRILIUM_NETWORK_CORSALLOWORIGIN: "https://myapp.com"
      TRILIUM_SYNC_SYNCSERVERHOST: "https://sync.example.com"
      TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL: "https://auth.example.com"

      # Or using shorter alternatives (equally valid)
      # TRILIUM_NETWORK_CORS_ALLOW_ORIGIN: "https://myapp.com"
      # TRILIUM_SYNC_SERVER_HOST: "https://sync.example.com"
      # TRILIUM_OAUTH_BASE_URL: "https://auth.example.com"

Shell 导出示例

# Using either format
export TRILIUM_GENERAL_NOAUTHENTICATION=false
export TRILIUM_NETWORK_HTTPS=true
export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem
export TRILIUM_NETWORK_KEYPATH=/path/to/key.pem
export TRILIUM_LOGGING_RETENTIONDAYS=30

# Start Trilium
npm start

config.ini参考资料

有关配置选项及其 INI 文件格式的完整列表,请查看 Trilium 存储库中的config-sample.ini文件

“您的支持是我持续分享的动力”

微信收款码
微信
支付宝收款码
支付宝

目录关闭