2

Configuration

LamGC edited this page 2022-03-20 17:13:59 +08:00

Table of Contents

• config.json
• bot.json

config.json

{
  // 全局代理配置(扩展除外).
  // 当机器人缺少 proxy 属性时, 将使用全局代理配置.
  "proxy": {
    // 代理类型(不区分大小写)有 "No_Proxy"(不使用代理)/"Http"/"Https"/"Socks5"
    "type": "NO_PROXY",
    // 代理服务器地址(不包括协议)
    "host": "127.0.0.1",
    // 代理服务器端口.
    "port": 1080
  },
  // 运行指标配置.
  // 运行指标可以反映程序的运行状况, 可以将运行指标用于运维监控.
  // 运行指标兼容 Prometheus, 访问地址为 `http://[Server IP]:[Port]/metrics`.
  "metrics": {
    // 是否启用运行指标服务端.
    // 如果开启, 将会在指定端口启动一个 Http 服务器, 可配置 Prometheus 获取运行指标数据.
    "enable": false,
    // 导出用的 Http 服务端所使用的端口.
    "port": 9386,
    // Http 服务端绑定的 IP 地址, 绑定后只有该地址可以访问运行指标服务端.
    "bindAddress": "0.0.0.0"
  },
  // Maven 仓库列表.
  // 适用于需要在 Maven 仓库搜索和下载的扩展包.
  "mavenRepositories": [
    // Json 形式的 Maven 仓库配置
    {
      // Maven 远端仓库地址.
      "url": "https://repo1.maven.org/maven2/",
      // 访问 Maven 仓库所使用的代理配置.
      // 如果不需要代理, 则删除这个属性.
      "proxy": {
        // 代理类型, 支持 "http"/"https".
        "type": "http",
        // 代理服务器地址.
        "host": "127.0.0.1",
        // 代理服务器端口.
        "port": 1080
      },
      // Maven 仓库布局类型, Maven 2 开始使用了新的 Maven 仓库布局, Maven 1 为旧布局.
      // 对于 Maven 2 或以上, 仓库布局为 "default", 如果是 Maven 1 仓库, 则是 "legacy".
      "layout": "default",
      // 仓库认证配置. 如果无需认证, 可删除该属性.
      // 目前没有更多关于该配置的信息, 有关信息后续再进行补充.
      "authentication": null
    },
    // 如果不需要特别配置, 也可以直接填写仓库地址.
    // 默认已内置 Maven 中央仓库.
    "https://repo1.maven.org/maven2/"
  ]
}

bot.json

[
  {
    // 是否启用机器人, 如果为 false, 那么在启动时将不会启动该机器人.
    "enabled": false,
    // 机器人账号
    "account": {
      // 机器人用户名, 可以与实际的不同, 但为了方便管理, 建议与机器人用户名相同(机器人用户名 @xxxbot 后面那段 xxxbot).
      "name": "Bot Username",
      // 机器人的 API 令牌, 在 Telegram 中联系 @BotFather 创建并获取 botToken.
      "token": "Bot API Token",
      // 机器人账号的所有者 Telegram 用户 Id, 可联系 @userinfobot 获取自己的用户 Id.
      "creatorId": -1
    },
    // 是否禁用 TelegramBots 内置的基础命令.
    // TelegramBots 内置了一些管理命令, 如果有安装另外的管理扩展, 可考虑禁用.
    // https://github.com/rubenlagus/TelegramBots/blob/master/telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/bot/DefaultAbilities.java#L70
    // 默认不禁用.
    "disableBuiltInAbility": false,
    // 是否自动更新 Telegram 机器人命令列表.
    // 如果开启, 机器人将在扩展加载完成后, 收集命令信息并向 Telegram 更新命令列表.
    // 更新后, 用户将会看到机器人可用的命令信息.
    // 注意, 机器人关闭时不会还原命令列表.
    "autoUpdateCommandList": false,
    // 机器人所使用的扩展.
    // 
    "extensions": [
      "group:artifact:version"
    ],
    // 对该机器人设置的独立代理配置.
    // 如果机器人不存在 proxy 配置, 那么将会使用 config.json 中的代理配置.
    // 可在机器人代理配置中, 将 type 设为 `NO_PROXY` 来显性地表明该机器人不需要代理.
    "proxy": {
      // 代理类型(不区分大小写)有 "No_Proxy"(不使用代理)/"Http"/"Https"/"Socks5"
      "type": "NO_PROXY",
      // 代理服务器地址(不包括协议)
      "host": "127.0.0.1",
      // 代理服务器端口.
      "port": 1080
    },
    // Telegram API 地址, 默认不用改, 如果有自建 Telegram Bot API 节点的可以修改为自建 API 地址.
    "baseApiUrl": "https://api.telegram.org/bot"
  },
  // ...
]