Install Agent

Beszel Agent also supports installation via Docker or using binaries.

• Docker
• Binary
  • Quick script
  • Manual download and startup
  • Build and Startup

Requirements

The server needs to open a port for the Hub to connect, so it is not suitable for servers in a private network (and not in the same private network as the Hub).

Hub

On the web panel, an installation command is provided for copying. You can choose to copy the command directly for installation or refer to this document to continue with manual installation.

Docker

• PROT : Port
• KEY : Public Key

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
      # monitor other disks / partitions by mounting a folder in /extra-filesystems
      # - /mnt/disk1/.beszel:/extra-filesystems/disk1:ro
    environment:
      PORT: <port>
      KEY: "<public key>"
      # FILESYSTEM: /dev/sda1 # override the root partition / device for disk I/O stats

Binary

There are multiple ways to install using binary files. You can choose one of the methods below that you prefer.

1. Quick script

• -p : Port
• -k : Public Key

curl -sL https://raw.githubusercontent.com/henrygd/beszel/main/supplemental/scripts/install-agent.sh -o  install-agent.sh && chmod +x install-agent.sh && ./install-agent.sh -p <port> -k "<public key>"

2. Manual Download and Startup

Click to expand/collapse

Download the latest binary from releases that matches your server's CPU architecture and run it manually. However, you will need to create a service manually to keep it running.

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

Running the agent directly:

• PROT : Port
• KEY : Public Key

PORT=<port> KEY="<public key>" ./beszel-agent

3. Build and Startup

Click to expand/collapse

Beszel are written in Go, so you can easily build them yourself, or cross-compile for different platforms. Please install Go first if you haven't already.

1. Git clone & Prepare dependencies

git clone https://github.com/henrygd/beszel.git
cd beszel && go mod tidy

4. Build

cd beszel/cmd/agent
CGO_ENABLED=0 go build -ldflags "-w -s" .

TIP

If you need to run on different platforms, you can cross-compile using the GOOS and GOARCH environment variables.

For example, to build for FreeBSD ARM64:

GOOS=freebsd GOARCH=arm64 CGO_ENABLED=0 go build -ldflags "-w -s" .

You can see a list of valid options by running go tool dist list.

4. Running the agent directly

You will need to create a service manually to keep it running.

• PROT : Port
• KEY : Public Key

PORT=<port> KEY="<public key>" ./beszel-agent