跳到主要内容

配置

Chronocat 的默认配置已经完全能够满足基础需求，因此一般情况下无需修改。而如果你希望开启多个 Chronocat 服务或需要多账号登录，则可以参考下方的指南进行自定义配置。

位置​

Chronocat 配置文件位于 ~/.chronocat/config/chronocat.yml。要打开这个文件：

  • 在 Windows 上，按下 Win+R，然后输入 "%USERPROFILE%/.chronocat/config" 并回车。
  • 在 macOS 上，在桌面按下 ⌘⇧G，然后输入 ~/Library/Containers/com.tencent.qq/Data/.chronocat/config 并回车。
  • 在 Linux 上，在桌面按下 Alt+F2，然后输入 ~/.chronocat/config 并回车。

生成​

自动生成​

大多数情况下，Chronocat 配置文件是自动生成的。Chronocat 生成配置文件会经过如下两步：

  1. 从默认配置文件生成一份全新的、带注释的配置文件。默认配置文件可以在本页的底部查看；
  2. 生成一个高强度密码，将配置文件中的服务密码（token 字段）设置为该密码。

因此，自动生成的配置文件已同时满足开箱即用的便利性和安全性两大要求，大多数情况下无需修改。

初始化服务密码​

在自动生成时，如果提供了 --chrono-default-token 命令行参数或 CHRONO_DEFAULT_TOKEN 环境变量，则会使用提供的值设置服务密码。命令行参数优先于环境变量。

手动创建​

在一些特殊环境下，你可能希望先手动配置好 Chronocat 配置文件，再启动 Chronocat。如果你希望手动创建配置文件，则可以用自动生成类似的做法：

  1. 从页面底部获得一份默认配置文件，并参考上面的「位置」一节将配置文件存储到正确的位置；
  2. 将文件内的所有 DEFINE_CHRONO_TOKEN 替换成自己准备的服务密码。
必须替换服务密码

默认配置文件中，所有服务密码字段的值都是 DEFINE_CHRONO_TOKEN。只要检测到这个值，Chronocat 就不会启动。在启动 Chronocat 之前，你需要将所有 DEFINE_CHRONO_TOKEN 字样都替换成你自己的服务密码。这有助于避免 密码喷洒攻击。

从 v0.0.45 迁移​

如果你从 Chronocat 版本 0.0.45 或更早迁移，那么：

  • 新的默认配置会生成，且所有 token 配置项将会保持与旧的 RED_PROTOCOL_TOKEN 文件一致。
  • 旧的 RED_PROTOCOL_TOKEN 文件将会失效，但将被保留。 请在迁移后及时删除旧文件，避免造成混淆。

编辑​

我们推荐使用任意一款带有 LSP 功能的编辑器来编辑 Chronocat 配置文件：

（点击编辑器以安装所需的插件）

此外，我们推荐为编辑器配置一款等宽字体，这样可以极大地改善配置文件的编辑体验。

参考​

参考页展示了完整的 Chronocat 配置文件结构。

Chronocat 配置文件参考

示例​

你可以直接从本站下载配置文件相关资源：

这里也有一份完整的、默认的 chronocat.yml 文件供参考：

chronocat.yml
# yaml-language-server: $schema=https://chronocat.vercel.app/config-v0.schema.json
#
################################################################
#                      Chronocat 配置文件
################################################################
#
# 你好！
#
# 这是 Chronocat 的配置文件。Chronocat 的所有配置以及每个账号
# 的独立配置都存放在这个文件里。
#
# 这是 Chronocat 配置的文档：
# https://chronocat.vercel.app/config
# 如果还没有看过的话，请先看一下！
#
# 如果你现在并不是使用完整功能的编辑器编辑此文件的话，
# 我们推荐你使用一款完整功能的编辑器来编辑！
# 这样的编辑器在你不小心改错配置的时候会智能地给出提示。
# 想要了解更多请查看上面的文档 ↑
#
################################################################
#                           全局配置
################################################################
#
# 下面的配置是通用的！如果你只登录一个账号，
# 那么只需修改下面这部分配置即可！
#
################################################################

# servers：服务配置
#
# 配置 Chronocat 开启的服务。需要尤其注意服务列表的格式哦~
servers:
  # type：服务类型
  #
  # 开启 Satori 服务只需要指定 type 为 satori 即可。
  - type: satori

    # token：服务密码
    #
    # Chronocat 已经自动生成了随机密码。要妥善保存哦！
    # 客户端使用服务时需要提供这个密码！
    token: DEFINE_CHRONO_TOKEN

    # port：服务端口
    #
    # Chronocat 开启 satori 服务的端口，默认为 5500。
    port: 5500

################################################################
#                           账号配置
################################################################
overrides:
  ##############################################################
  #
  # 下面的配置是每个账号专属的！修改下面的配置会覆盖上面的配置哦~
  # 修改的时候要特别注意：账号前空两格，账号内配置要空四格哦！
  #
  ##############################################################

  10000:
    servers:
      - type: satori
        token: DEFINE_CHRONO_TOKEN
        port: 5501