Skip to content

外观设置

阅读外观

阅读字体

主题色

配色风格

配色规范

背景图

开启随机壁纸,关闭使用主题底色

背景纹理

减少动态效果

设置即时生效,自动保存到当前浏览器

官网选择与网站绑定 ​

← 官网与 API · 所有分区

适用于 VexBot v0.6.30。新安装内置面板与 API 默认端口 5800,源码新版 WebUI 为 5801,独立官网本机预览为 8089。已有配置保持实际端口。

先选择接入方式 ​

面板选择适用情况需要完成的事
不接入官网只使用 Bot、游戏服及群功能;新安装默认保持此模式即可,Bot 可独立运行
使用 VexBot 提供的官网需要现成的首页、服务器状态和玩家账号页下载独立项目、自行部署、填写网站与 API 地址并替换 config.json
接入自己的官网已有自己的页面和内容填写网站地址,用本页 API 或 SDK 接入所需功能

两种接入方式均需网站地址,使用同一套 HTTP API 和来源授权。选择提供的官网不会自动部署网站;选择自有官网后,页面设计与内容由自己的项目管理,Bot 显示 API 公开范围设置及接口文档。

「不接入官网」保留已保存的网站地址和官网设置,停止允许该网站来源的跨域请求,旧官网入口不再跳转;不会启动、停止或部署外部网站服务。不关闭公共 API、注册功能或撤销用户令牌;其他手动授权来源仍可使用。

在新版控制台中设置 ​

服主登录 5801 新版控制台后,进入 控制台设置 → 网站详细设置。这里与 5800 内置面板的「接入空间 → 网站绑定」管理同一份后台设置;团队账号不能读取或修改网站管理设置。

新版选项显示的详细设置
不接入官网保留已保存的地址、内容和外观;公开 API 三个开关仍可独立调整
自定义网站网站地址、Bot API 地址、玩家信息 API、公开服务器状态、网站密码登录 API
VexBot 官网上述接入配置,以及标题、副标题、社区介绍、规则、游戏地址、群聊链接、主色、辅助色、主题、网格背景

修改后点击「保存网站设置」,等待同步成功;下方「保存预览设置」只保存浏览器内的演示偏好。保存成功后可下载接入配置、指南和 SDK;官网项目包仅在「VexBot 官网」模式提供。下载配置前须明确填写并保存 API 地址,修改尚未保存时检查和下载暂时停用。

建议明确填写访客可访问的 https://bot.example.com/api/v1,本机测试填写 http://127.0.0.1:5800/api/v1。新版控制台允许 API 地址留空并保持空值,公开检查会通过当前控制台的 /api/v1 代理发起;检查成功不能证明 8089 官网或外网玩家能访问。需要官网同源反向代理时填写 /api/v1 并在官网服务器配置相应路由,勿把控制台的 5801 地址当作公开 Bot 地址。

切页会保留未保存草稿。版本冲突或保存结果未确认时,可点击「载入最新版本,保留草稿」,核对重新合并的内容后再保存。接入操作不要求把管理令牌或网站后端密钥填写到网页;网站服务端查询私人账号资料仍使用下文独立的凭据规则。

配置步骤 ​

  1. 在「网站绑定」选择「使用 VexBot 提供的官网」或「接入自己的官网」,填写网站地址、Bot 公开 API 地址并保存。网站地址支持子目录,例如 https://www.example.com/community/;Bot 会自动允许其准确来源 https://www.example.com。
  2. 需要注册或密码找回时,在「成员 → 注册账号」配置 SMTP 和发件人;需要开放新用户注册时再启用注册。只展示公开信息可以跳过。官网登录不依赖注册开关,已注册用户可在停止新注册后继续登录。
  3. 使用 VexBot 提供的官网时,设置官网名称、首页内容、游戏地址、入群链接及外观;两种接入方式都检查公开范围与官网登录开关。接入网站无需重复填写注册来源白名单;其他第三方网站可继续在注册设置中加入精确来源,不支持 * 或 file://。
  4. API 地址填写 https://bridge.example.com/api/v1,保存后下载接入配置;同来源反向代理 /api/v1/ 时可填写 /api/v1。
  5. 使用 VexBot 提供的官网时,解压下载的独立项目,用新下载的 config.json 替换根目录配置,上传所有网页文件。站点可位于子目录,资源使用相对地址,导航使用 hash,不需要 SPA 重写规则。自有官网按下方 SDK 示例修改自己的项目。
  6. 按实际启用的功能测试服务器状态、注册、登录、本人档案和找回密码,再向玩家提供官网地址。

最小本机预览 ​

先在「网站绑定」选择「使用 VexBot 提供的官网」,网站地址填 http://127.0.0.1:8089/,API 地址填 http://127.0.0.1:5800/api/v1,保存并允许公开服务器。下载并解压项目,在独立项目目录执行:

powershell
python serve.py --port 8089 --api-base http://127.0.0.1:5800/api/v1

Windows 也可执行:

powershell
.\start.ps1 -ApiBase http://127.0.0.1:5800/api/v1

Bot 使用其他端口时同步替换 API 地址。打开 http://127.0.0.1:8089/,应看到面板配置的社区名称;服务器页包含所有已配置服务器,未连接服务器也会显示。此时只需完成公开信息读取,再按 验收 测试注册与登录。

启动工具只依赖 Python 3.11+ 标准库,不依赖 Bot 或父目录;--api-base 覆盖本次服务的配置,不修改磁盘,不指定时读取项目 config.json。正式静态部署不需要 Python。API 的 127.0.0.1 对外网玩家指向玩家自己的机器,正式部署须使用玩家可访问的地址。

独立打包:python build.py --api-base https://bridge.example.com/api/v1,生成 dist/VexBot-website.zip;--output 可指定输出位置。只读取项目固定文件,API 地址写入压缩包,原始配置保持不变。Bot 的发布脚本会将同一官网包放到内部兼容路径 dist/StarBridge-website.zip,面板以新品牌文件名提供下载;源码手动部署时,将独立构建的 ZIP 复制到该兼容路径即可。

选择「不接入官网」后,即使该来源同时存在于手动白名单,Bot 也拒绝该网站来源的跨域 API 请求;其他手动授权网站不受影响。CORS 不代替身份验证,不阻止非浏览器客户端,关闭接入不会撤销用户令牌或关闭公共 API。旧 /community/ 地址在接入时跳转到网站,未接入时返回 404,静态资源不再从 Bot 提供。接入方式保存在 website_mode(none/provided/custom);旧版启用的接入设置迁移为 custom,关闭的设置迁移为 none,不会擅自更换地址。

公网官网和 API 使用 HTTPS,避免浏览器混合内容拦截。独立项目内提供 nginx.example.conf,自行填写目录、域名和证书;反向代理应只公开需要的 /api/v1/ 与官网资源,管理面板可保留在内网。VexBot 当前以实际 socket 地址限流,不信任任意 X-Forwarded-For,经代理的用户可能共用额度。

保存与检查的边界 ​

Bot 保存接入设置不会修改远端网页或 config.json,需要下载新接入配置并替换部署文件。“检查 API”只验证当前管理浏览器能读取公开 API,不证明外网玩家或独立官网能访问;检查不会向目标地址发送管理令牌。接入操作无需在前端保存任何网站后端密钥。

独立官网部署 · 完整公开与本人 API · 浏览器 SDK。