beszel/readme.md

Beszel *WIP*

A lightweight server resource monitoring hub with historical data, docker stats, and alerts.

Introduction

Beszel has two components: the hub and the agent.

The hub is a web application that provides a dashboard to view and manage your connected systems. It's built on top of PocketBase.

The agent runs on each system you want to monitor. It creates a minimal SSH server through which it communicates system metrics to the hub.

Getting started

If using the binary instead of docker, ignore 4-5 and run the agent using the binary instead.

1. Start the hub (see Installation). The binary command is beszel serve.
2. Open http://localhost:8090 and create an admin user.
3. Click "Add system." Enter the name and host of the system you want to monitor.
4. Click "Copy docker compose" to copy the agent's docker-compose.yml file to your clipboard.
5. On the agent system, create the compose file and run docker compose up to start the agent.
6. Back in the hub, click the "Add system" button in the dialog to finish adding the system.

If all goes well, you should see the system flip to green. If it goes red, check the Logs page, and see troubleshooting tips.

Installation

You may choose to install the hub and agent as single binaries, or as docker images.

Docker

Hub: See the example docker-compose.yml file.

Agent: The hub provides compose content for the agent, but you can also reference the example docker-compose.yml file.

The agent uses the host network mode so it can access network interface stats. This automatically exposes the port, so change the port using an environment variable if you need to.

If you don't need network stats, remove that line from the compose file and map the port manually.

Note

: The docker version of the agent cannot automatically detect the filesystem to use for disk I/O stats, so include the FILESYSTEM environment variable if you want that to work (instructions here).

Binary

Download and run the latest binaries from the releases page or use the commands below.

Hub:

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

Agent:

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

Updating

Use beszel update and beszel-agent update to update to the latest version.

Environment Variables

Hub

Name	Default	Description
DISABLE_PASSWORD_AUTH	false	Disables password authentication

Agent

Name	Default	Description
FILESYSTEM	unset	Filesystem / partition to use for disk I/O stats
KEY	unset	Public SSH key to use for authentication. Provided in hub.
PORT	45876	Port to listen on

OAuth / OIDC setup

Beszel supports OpenID Connect and many OAuth2 authentication providers (see list below). To enable, do the following:

1. Create an OAuth2 application using your provider of choice. The redirect / callback URL should be <your-beszel-url>/api/oauth2-redirect.
2. When you have the client ID and secret, go to the "Auth providers" page and enable your provider.

Supported provider list

• Apple
• Bitbucket
• Discord
• Facebook
• Gitea
• Gitee
• GitHub
• GitLab
• Google
• Instagram
• Kakao
• LiveChat
• mailcow
• Microsoft
• OpenID Connect
• Patreon (v2)
• Spotify
• Strava
• Twitch
• Twitter
• VK
• Yandex

REST API

Because Beszel is built on PocketBase, you can use the PocketBase Web APIs and Client-side SDKs to read or update data from outside Beszel itself.

Security

The hub and agent communicate over SSH, so they don't need to be exposed to the internet. And the connection won't break if you put your own auth gateway, such as Authelia, in front of the hub.

When the hub is started for the first time, it generates an ED25519 key pair.

The agent's SSH server is configured to accept connections only using this key. It does not provide a pty or accept any input, so it is not possible to execute commands on the agent even if your private key is compromised.

FAQ / Troubleshooting

Agent is not connecting

Assuming the agent is running, the connection is probably being blocked by a firewall. You need to add an inbound rule on the agent system to allow TCP connections to the port. Check any active firewalls, like iptables or ufw, and in your cloud provider account if applicable.

Connectivity can be tested by running telnet <agent-ip> <port> or nc -zv <agent-ip> <port> from a remote machine.

Finding the correct filesystem

The filesystem / partition to use for disk I/O stats is specified in the FILESYSTEM environment variable.

If it's not set, the agent will try to find the filesystem mounted on / and use that. This doesn't seem to work in a container, so it's recommended to set this value. One of the following methods should work (you usually want the option mounted on /):

• Run df -h and choose an option under "Filesystem"
• Run lsblk and choose an option under "NAME"
• Run sudo fdisk -l and choose an option under "Device"

Month / week records are not populating reliably

Records for longer time periods are made by averaging stats from the shorter time periods. They require the agent to be running uninterrupted for long enough to get a full set of data.

If you pause / unpause the agent for longer than one minute, the data will be incomplete and the timing for the current interval will reset.