5 分钟快速开始:控制面与一台 Paper 服务
本教程用 SQLite 跑通最小闭环:启动 Beacon 控制面、让一台 Paper/Bukkit 服务上的 Agent 注册、在管理台确认身份。它适合本机验证和功能体验,不替代 生产部署。
完成后,你会得到一台状态为 active 的受管后端服务。BC、全局大厅和小区
拓扑请继续阅读从零搭建完整集群。
1. 开始前
准备与同一 Beacon 发布版本匹配的以下文件:
- Beacon 控制面二进制;
- 一台可启动的 Paper/Bukkit 服务及
BeaconAgent; - 可从该服务访问控制面的网络路径。
在一个新的、可持久化的工作目录中运行控制面。首次启动会在该目录生成
config.yml 和 SQLite 数据文件;不要把这个目录、其中的口令或数据库文件提交
到版本库。
本教程不使用 Docker Compose 的 MySQL。仓库内 Compose 当前是单控制面 + SQLite 持久卷;生产 MySQL 应由你单独部署,详见完整集群教程。
2. 启动 SQLite 控制面
将控制面二进制放入工作目录并运行它。以下命令仅示意可执行文件名;请按操作 系统调整启动方式:
<beacon-binary>
首次运行会释放 config.yml,并为管理面认证生成随机强口令与签名密钥。打开本
机的 config.yml,只在受控终端中读取 auth.username 和 auth.password,然后用
该文件中配置的监听地址打开管理台。
不要把生成的口令、签名密钥、数据库文件或管理台 URL 复制到聊天记录、截图、
仓库或日志。需要修改控制面监听地址、数据库或认证配置时,先停止进程、修改
config.yml,再启动;这些是启动配置而非管理台热改项。
3. 创建 namespace 与接入 token
- 使用刚生成的管理员凭据登录管理台。
- 在“命名空间”创建一个仅供本次测试使用的 namespace。
- 创建或取得该 namespace 的接入 token,并立即保存到受控的秘密管理或部署 渠道;一次性明文展示后不应期待可以再次读取。
namespace 由 token 权威推导。不要在 Agent 配置中手工声明 namespace、serverId、
Region、Zone、LobbyCluster、地址、容量或调度权重。
4. 安装并配置 BeaconAgent
- 停止 Paper/Bukkit 服务。
- 将与控制面版本匹配的
BeaconAgent放入该服务的plugins/目录。 - 在 Agent 配置中只提供控制面 endpoint 列表和上一步取得的 namespace token:
beacon:
endpoints:
- "<CONTROL_PLANE_URL>"
bootstrap-token: "<NAMESPACE_ACCESS_TOKEN>"
<CONTROL_PLANE_URL> 必须是这台 Paper 服务实际可访问的地址。<NAMESPACE_ACCESS_TOKEN>
只能由受控部署渠道注入;示例中的占位符不能原样使用。
首次启动时,Agent 会为本机生成 identityId 并向控制面申请注册。保留
plugins/Beacon* 下的本地身份与快照文件;它们不是可复制的模板,也不能靠删除
来“重置”或强制激活实例。