跳转到主要内容
Beacon

使用手册

Beacon 使用手册

支持一键安装、手动安装与离线安装，几分钟完成部署，开箱即用。

01

安装使用

环境依赖

安装 Beacon 前请确保你的系统环境符合以下要求：

  • 操作系统：Linux
  • CPU 指令架构：x86_64, arm64
  • 软件依赖：Docker 20.10.14 版本以上
  • 软件依赖：Docker Compose 2.0.0 版本以上
  • 最低资源需求：1 核 CPU / 2 GB 内存 / 5 GB 磁盘

Beacon 支持一键安装与手动安装。安装前请确认系统满足环境依赖要求。

一键安装

bash
# 一键安装（推荐新手使用）
bash -c "$(curl -fsSLk https://beacon.amuluze.com/release/latest/manager.sh)"

# 非交互安装示例
bash -c "$(curl -fsSLk https://beacon.amuluze.com/release/latest/manager.sh)" -- install BEACON_HTTP_PORT=1443 BEACON_PUBLIC_BASE_URL=https://beacon.example.com

# 一键升级
bash -c "$(curl -fsSLk https://beacon.amuluze.com/release/latest/manager.sh)" -- upgrade

# 一键卸载
bash -c "$(curl -fsSLk https://beacon.amuluze.com/release/latest/manager.sh)" -- uninstall

离线环境安装：如果你的服务器无法连接互联网，可以下载离线安装包（镜像包 + compose.yaml + .env 模板）后手动加载并启动。

手动安装

bash
mkdir -p /data/beacon && cd /data/beacon
curl -fsSLO https://beacon.amuluze.com/release/latest/compose.yaml
curl -fsSLO https://beacon.amuluze.com/release/latest/SHA256SUMS
# 使用 openssl rand -hex 32 生成三个独立随机密钥
cat > .env <<EOF
BEACON_IMAGE=registry.cn-hangzhou.aliyuncs.com/amuluze/beacon:v3.0.4
BEACON_VERSION=v3.0.4
BEACON_CONTAINER_NAME=beacon
BEACON_HTTP_PORT=1443
BEACON_CONTROL_PORT=17000
BEACON_DATA_DIR=./data
BEACON_LOG_DIR=./logs
BEACON_DB_NAME=/app/data/beacon
BEACON_PUBLIC_BASE_URL=http://127.0.0.1:1443
BEACON_AGENT_INSTALL_TOKEN=<your-token>
BEACON_AUTH_SIGNING_KEY=<your-key>
BEACON_CONTROL_JOIN_TOKEN=<your-token>
EOF

运维命令

bash
cd /data/beacon
docker compose up -d        # 启动 / 更新
docker compose ps           # 查看状态
docker compose logs -f      # 查看日志
docker compose down         # 停止服务

启动 Beacon 容器后，浏览器访问 http://服务器IP:1443 即可进入管理面板。初始管理员账号 admin / admin123；默认密码已公开，首次登录后请立即在「设置」中修改。

02

安装 Collia Agent

Collia 是 Beacon 的采集端，部署在被监控主机上，采集主机与 Docker 指标并主动建立反向通道接收 Server 控制。Server 部署完成后，按以下步骤在目标主机安装 Collia。

前置条件

  • Beacon Server 已部署并正常运行
  • 目标主机：Linux（x86_64 或 arm64），具备 root 权限
  • 从管理面板「安装 Agent」对话框获取 install token
  • 准备 node 节点标识符：字母或数字开头，仅含字母、数字、点、下划线、短横线

一键安装

bash
# 在被监控主机执行，替换地址、节点名与 token
curl -kfsSL 'https://<beacon-host>/api/v1/host/install?node=node-01' | sudo bash -s -- --token=<your-install-token>

脚本会自动识别 CPU 架构（amd64 / arm64），下载对应的 collia 二进制与节点配置，注册为系统服务并启动，同时建立到 Beacon 的反向控制通道。若 Server 启用 TLS，脚本还会自动拉取并解压该节点的证书。

服务管理

Collia 通过系统服务（systemd）常驻运行，安装完成后可使用以下命令管理：

bash
collia status     # 查看服务状态
collia stop       # 停止服务
collia start      # 启动服务
collia remove     # 卸载系统服务

目录与文件

  • 二进制：/usr/sbin/collia
  • 配置文件：/etc/collia/config.yml
  • 运行日志：/data/beacon/logs/collia/collia.log
  • 本地数据：/data/beacon/resources/collia/storage/

Collia 通过反向 gRPC tunnel 主动连接 Beacon，目标主机无需对外开放端口，只需保证能够访问 Beacon 的控制端口（默认 17000）。安装完成后，该主机会在管理面板「主机」列表中自动上线。

03

常见问题

部署与使用中的高频问题解答。

Q

安装前需要准备什么环境？

A

操作系统需为 Linux（x86_64 或 arm64），Docker 版本 20.10.14 以上，Docker Compose 2.0.0 以上，最低 1 核 CPU / 2 GB 内存 / 5 GB 磁盘。

Q

如何更新到最新版本？

A

执行一键升级命令：bash -c "$(curl -fsSLk https://beacon.amuluze.com/release/latest/manager.sh)" -- upgrade。升级前会自动备份 .env 与 compose.yaml，健康检查失败会自动回滚。

Q

初始账号密码是什么？

A

初始管理员账号 admin / admin123。默认密码已对外公开、极不安全，首次登录后请立即在「设置」中修改。

Q

如何获取技术支持？

A

通过 GitHub Issues 反馈需求与问题，或邮件联系 314901758@qq.com，也可关注公众号获取更新动态。

技术支持

在 GitHub Issues 描述问题、版本与复现步骤，我们会尽快跟进。

提交 Issue