Skip to content

README.md

Latest commit

聽

History

History
99 lines (67 loc) 路 2.56 KB

README.md

File metadata and controls

99 lines (67 loc) 路 2.56 KB
Raw

Beszel Agent for OpenWrt

Lightweight server monitoring agent packaged for OpenWrt routers and devices.

Beszel is a lightweight server monitoring hub with historical data, docker stats, and alerts. This repository provides pre-built IPK/APK packages for easy installation on OpenWrt.

Installation

Automatic

Run the installation script:

sh <(wget -qO- https://github.com/vernette/beszel-agent-openwrt/raw/master/install.sh)

Manual

Check your device architecture:

grep DISTRIB_ARCH /etc/openwrt_release | cut -d"'" -f2

Download the appropriate package from the Releases page.

Or directly via wget:

# opkg
wget -O beszel-agent.ipk https://github.com/vernette/beszel-agent-openwrt/releases/download/vX.X.X/beszel-agent_X.X.X-r1_YOUR_ARCH.ipk
# apk
wget -O beszel-agent.apk https://github.com/vernette/beszel-agent-openwrt/releases/download/vX.X.X/beszel-agent_X.X.X-r1_YOUR_ARCH.apk

Note

Replace X.X.X with the version number and YOUR_ARCH with your device architecture

Install the package depending on your package manager:

# opkg
opkg install beszel-agent*.ipk
# apk
apk add --allow-untrusted beszel-agent*.apk

Note

--allow-untrusted is required because the package is not signed with an OpenWrt key

Configuration

Edit the configuration file:

vi /etc/config/beszel-agent # or nano

Configuration options:

config agent 'agent'
  option enabled '1' # enable agent
  option port '45876' # port for hub connection
  option public_key 'YOUR_PUBLIC_KEY_HERE' # public key from hub

  # if you want to use the outbound Websockets connection, you
  # also need to specify the `hub_url` and `token` options
  # (see https://beszel.dev/guide/security for details)
  option hub_url 'https://YOUR_BESZEL_HUB_URL_HERE'
  option token 'YOUR_AGENT_TOKEN_HERE'

  # optional, monitor extra disks (comma-separated, `device__label`)
  option extra_filesystems 'sda1__NAS'

Get your authentication key (and agent token, if necessary) from the Beszel hub when adding a new system.

Then enable and start the service:

service beszel-agent enable
service beszel-agent start

Fingerprint storage

The agent fingerprint is stored in /etc/config/beszel-agent (as option fingerprint, auto-populated on first start), so it survives reboots and sysupgrade. Runtime data lives in /var/lib/beszel-agent (tmpfs), avoiding flash wear.

Links