Beszel

简体中文

English

简体中文

English

主题

代理安装 ​

Beszel 代理支持通过 Docker / Podman、单一二进制文件、Homebrew 包、Scoop 包或 Home Assistant 插件进行安装。

提示

如果您是首次设置 Beszel，请查看 开始使用 指南。

要求 ​

如果代理和中心 (hub) 位于不同的主机上，您可能需要在代理系统的防火墙上更新配置，以允许代理端口上的传入 TCP 连接。

或者，使用 WireGuard、Tailscale (视频教程)、Cloudflare Tunnel（说明）或 Pangolin 等软件安全地绕过防火墙。

使用中心 (Hub) ​

在添加新系统时，中心 (hub) 的 Web UI 中提供了可供复制/粘贴的 docker-compose.yml 或二进制安装命令。

添加系统对话框

Docker 或 Podman ​

提示

在添加新系统时，可以从中心 (hub) 的 Web UI 复制预配置的 docker-compose.yml 内容，因此在大多数情况下，您不需要手动进行设置。

yaml
services:
  beszel-agent:
    image: henrygd/beszel-agent
    container_name: beszel-agent
    restart: unless-stopped
    network_mode: host
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      # 通过在 /extra-filesystems 中挂载文件夹来监控其他磁盘/分区
      # - /mnt/disk1/.beszel:/extra-filesystems/disk1:ro
    environment:
      LISTEN: 45876
      KEY: '<公钥>'
bash
docker run -d \
  --name beszel-agent \
  --network host \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -e KEY="<公钥>" \
  -e LISTEN=45876 \
  henrygd/beszel-agent:latest
bash
podman run -d \
  --name beszel-agent \
  --network host \
  --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -e KEY="<公钥>" \
  -e LISTEN=45876 \
  docker.io/henrygd/beszel-agent:latest

为什么使用主机网络模式？ ​

代理必须使用主机网络模式才能访问主机的网络接口统计数据。这会自动暴露端口，因此如果需要，请使用环境变量更改端口。

如果您不需要主机网络统计数据，可以从 compose 文件中删除该行并手动映射端口。

连接到本地代理时，localhost 将不起作用，因为容器位于不同的网络中。请参阅 入门指南 中的 Unix 套接字连接示例。

二进制文件 ​

Beszel 使用纯 Go 编写，如果没有预构建的二进制文件，可以很容易地进行编译（或交叉编译）。

1. Linux 安装脚本 ​

需要 root 权限

该脚本需要 root 权限来创建 beszel 用户，并设置服务以确保代理在重启后继续运行。代理进程本身不以 root 身份运行。

该脚本会安装最新的二进制文件，并可选地启用每日自动更新。

  • -k：公钥（用引号括起来；如果未提供则进入交互模式）
  • -p：端口或地址（默认：45876）
  • -u：卸载
  • --auto-update：启用或禁用每日自动更新（如果未提供则进入交互模式）
  • --china-mirrors：使用 GitHub 镜像以解决中国大陆的网络问题
  • -h：显示帮助信息
bash
curl -sL https://get.beszel.dev -o /tmp/install-agent.sh && chmod +x /tmp/install-agent.sh && /tmp/install-agent.sh

2. 手动下载和启动 (Linux, FreeBSD, 其他) ​

点击展开/收起

下载二进制文件 ​

从 releases 下载与您的服务器操作系统/架构匹配的最新二进制文件。

bash
curl -sL "https://github.com/henrygd/beszel/releases/latest/download/beszel-agent_$(uname -s)_$(uname -m | sed -e 's/x86_64/amd64/' -e 's/armv6l/arm/' -e 's/armv7l/arm/' -e 's/aarch64/arm64/').tar.gz" | tar -xz -O beszel-agent | tee ./beszel-agent >/dev/null && chmod +x beszel-agent

启动代理 ​

使用 -h 查看所有可用选项。

bash
./beszel-agent -listen "45876" -key "<公钥>"

更新代理 ​

bash
./beszel-agent update

创建服务（可选） ​

如果您的系统使用 systemd，您可以创建一个服务以使中心在重新启动后继续运行。

  1. 在 /etc/systemd/system/beszel-agent.service 中创建一个服务文件。
ini
[Unit]
Description=Beszel Agent Service
After=network-online.target
Wants=network-online.target

[Service]
ExecStart={/path/to/working/directory}/beszel-agent
Environment="LISTEN=$LISTEN"
Environment="KEY=$KEY"
# Environment="EXTRA_FILESYSTEMS=sdb"
Restart=on-failure
RestartSec=5
StateDirectory=beszel-agent

# 安全/沙盒设置
KeyringMode=private
LockPersonality=yes
NoNewPrivileges=yes
PrivateTmp=yes
ProtectClock=yes
ProtectHome=read-only
ProtectHostname=yes
ProtectKernelLogs=yes
ProtectSystem=strict
RemoveIPC=yes
RestrictSUIDSGID=true
SystemCallArchitectures=native

[Install]
WantedBy=multi-user.target
  1. 启用并启动服务。
bash
sudo systemctl daemon-reload
sudo systemctl enable beszel-agent.service
sudo systemctl start beszel-agent.service

3. 手动编译和启动 (任何平台) ​

点击展开/收起

编译 ​

请参阅 编译 了解有关如何自己编译中心的更多信息。

启动代理 ​

使用 -h 查看所有可用选项。

bash
./beszel-agent -listen "45876" -key "<公钥>"

更新代理 ​

bash
./beszel-agent update

创建服务（可选） ​

如果您的系统使用 systemd，您可以创建一个服务以使中心在重新启动后继续运行。

  1. 在 /etc/systemd/system/beszel-agent.service 中创建一个服务文件。
ini
[Unit]
Description=Beszel Agent Service
After=network-online.target
Wants=network-online.target

[Service]
ExecStart={/path/to/working/directory}/beszel-agent
Environment="LISTEN=$LISTEN"
Environment="KEY=$KEY"
# Environment="EXTRA_FILESYSTEMS=sdb"
Restart=on-failure
RestartSec=5
StateDirectory=beszel-agent

# 安全/沙盒设置
KeyringMode=private
LockPersonality=yes
NoNewPrivileges=yes
ProtectClock=yes
ProtectHome=read-only
ProtectHostname=yes
ProtectKernelLogs=yes
ProtectSystem=strict
RemoveIPC=yes
RestrictSUIDSGID=true
SystemCallArchitectures=native

[Install]
WantedBy=multi-user.target
  1. 启用并启动服务。
bash
sudo systemctl daemon-reload
sudo systemctl enable beszel-agent.service
sudo systemctl start beszel-agent.service

Homebrew (macOS, Linux) ​

环境变量可以在 ~/.config/beszel/beszel-agent.env 中更改。

日志写入到 ~/.cache/beszel/beszel-agent.log。

Homebrew 安装脚本 ​

  • -k：SSH 密钥（如果未提供则进入交互模式）
  • -p：端口（默认：45876）
  • -h：显示帮助信息
bash
curl -sL https://get.beszel.dev/brew -o /tmp/install-agent.sh && chmod +x /tmp/install-agent.sh && /tmp/install-agent.sh

Homebrew 手动安装 ​

bash
mkdir -p ~/.config/beszel ~/.cache/beszel
echo 'KEY="ssh-ed25519 AAAA..."' > ~/.config/beszel/beszel-agent.env
brew tap henrygd/beszel
brew install beszel-agent
brew services start beszel-agent

WinGet / Scoop (Windows) ​

代理可作为 WinGet 和 Scoop 包使用。

下面的脚本会在您已安装的情况下使用 Scoop，否则如果已安装 WinGet 则使用 WinGet。如果两者都不可用，它将同时安装 Scoop 和代理。

它还将安装 NSSM 并创建一个服务，以便在重启后继续运行代理。

  • -Key：SSH 密钥（如果未提供则进入交互模式）
  • -Port：端口（默认：45876）
powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser; & iwr -useb https://get.beszel.dev -OutFile "$env:TEMP\install-agent.ps1"; & "$env:TEMP\install-agent.ps1"

脚本的源代码可在 GitHub 上获取。

编辑配置 ​

通过运行以下命令在 NSSM 中编辑服务。在 GUI 中向右滚动以查找环境变量。

powershell
nssm edit beszel-agent

您也可以直接从命令行更改选项：

powershell
nssm set beszel-agent AppEnvironmentExtra "+EXTRA_FILESYSTEMS=D:,E:"

完成后重启服务：nssm restart beszel-agent

日志 ​

日志应写入 C:\ProgramData\beszel-agent\logs。

升级 ​

Scoop ​

powershell
nssm stop beszel-agent; & scoop update beszel-agent; & nssm start beszel-agent

WinGet ​

powershell
nssm stop beszel-agent; & winget upgrade henrygd.beszel-agent; & nssm start beszel-agent

卸载 ​

Scoop ​

powershell
nssm stop beszel-agent
nssm remove beszel-agent confirm
scoop uninstall beszel-agent

WinGet ​

powershell
nssm stop beszel-agent
nssm remove beszel-agent confirm
winget uninstall henrygd.beszel-agent

FreeBSD / OPNSense ​

FreeBSD 端口正在开发中，但尚未可用（欢迎贡献！）。我们还将在主安装脚本中添加 FreeBSD 兼容性。

目前，可以手动安装代理。请参阅以下内容获取更多信息：

Home Assistant ​

请参阅 Home Assistant 代理页面 获取将代理设置为 Home Assistant 插件的说明。

基于 MIT 许可发布