## File: README.md # Beszel Beszel is a lightweight server monitoring platform that includes Docker statistics, historical data, and alert functions. It has a friendly web interface, simple configuration, and is ready to use out of the box. It supports automatic backup, multi-user, OAuth authentication, and API access. [](https://hub.docker.com/r/henrygd/beszel-agent) [](https://hub.docker.com/r/henrygd/beszel) [](https://github.com/henrygd/beszel/blob/main/LICENSE) [](https://crowdin.com/project/beszel) ## Features - **Lightweight**: Smaller and less resource-intensive than leading solutions. - **Simple**: Easy setup with little manual configuration required. - **Docker stats**: Tracks CPU, memory, and network usage history for each container. - **Alerts**: Configurable alerts for CPU, memory, disk, bandwidth, temperature, fan speed, load average, and status. - **Multi-user**: Users manage their own systems. Admins can share systems across users. - **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled. - **Automatic backups**: Save to and restore from disk or S3-compatible storage. ## Architecture Beszel consists of two main components: the **hub** and the **agent**. - **Hub**: A web application built on [PocketBase](https://pocketbase.io/) that provides a dashboard for viewing and managing connected systems. - **Agent**: Runs on each system you want to monitor and communicates system metrics to the hub. ## Getting started The [quick start guide](https://beszel.dev/guide/getting-started) and other documentation is available on our website, [beszel.dev](https://beszel.dev). You'll be up and running in a few minutes. ## Screenshots ## Supported metrics - **CPU usage** - Host system and Docker / Podman containers. - **Memory usage** - Host system and containers. Includes swap and ZFS ARC. - **Disk usage** - Host system. Supports multiple partitions and devices. - **Disk I/O** - Host system. Supports multiple partitions and devices. - **Network usage** - Host system and containers. - **Load average** - Host system. - **Temperature** - Host system sensors. - **Fan speed** - Host system sensors (Linux, via `/sys/class/hwmon`). - **GPU usage / power draw** - Nvidia, AMD, and Intel. - **Battery** - Host system battery charge. - **Containers** - Status and metrics of all running Docker / Podman containers. - **S.M.A.R.T.** - Host system disk health (includes eMMC wear/EOL and Linux mdraid array health via sysfs when available). ## Help and discussion Please search existing issues and discussions before opening a new one. I try my best to respond, but may not always have time to do so. #### Bug reports and feature requests Bug reports and feature requests can be posted on [GitHub issues](https://github.com/henrygd/beszel/issues). #### Support and general discussion Support requests and general discussion can be posted on [GitHub discussions](https://github.com/henrygd/beszel/discussions) or the community-run [Matrix room](https://matrix.to/#/#beszel:matrix.org): `#beszel:matrix.org`. ## License Beszel is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. --- ## File: Readme.md # Beszel Beszel is a lightweight server monitoring platform that includes Docker statistics, historical data, and alert functions. It has a friendly web interface, simple configuration, and is ready to use out of the box. It supports automatic backup, multi-user, OAuth authentication, and API access. [](https://hub.docker.com/r/henrygd/beszel-agent) [](https://hub.docker.com/r/henrygd/beszel) [](https://github.com/henrygd/beszel/blob/main/LICENSE) [](https://crowdin.com/project/beszel) ## Features - **Lightweight**: Smaller and less resource-intensive than leading solutions. - **Simple**: Easy setup with little manual configuration required. - **Docker stats**: Tracks CPU, memory, and network usage history for each container. - **Alerts**: Configurable alerts for CPU, memory, disk, bandwidth, temperature, fan speed, load average, and status. - **Multi-user**: Users manage their own systems. Admins can share systems across users. - **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled. - **Automatic backups**: Save to and restore from disk or S3-compatible storage. ## Architecture Beszel consists of two main components: the **hub** and the **agent**. - **Hub**: A web application built on [PocketBase](https://pocketbase.io/) that provides a dashboard for viewing and managing connected systems. - **Agent**: Runs on each system you want to monitor and communicates system metrics to the hub. ## Getting started The [quick start guide](https://beszel.dev/guide/getting-started) and other documentation is available on our website, [beszel.dev](https://beszel.dev). You'll be up and running in a few minutes. ## Screenshots ## Supported metrics - **CPU usage** - Host system and Docker / Podman containers. - **Memory usage** - Host system and containers. Includes swap and ZFS ARC. - **Disk usage** - Host system. Supports multiple partitions and devices. - **Disk I/O** - Host system. Supports multiple partitions and devices. - **Network usage** - Host system and containers. - **Load average** - Host system. - **Temperature** - Host system sensors. - **Fan speed** - Host system sensors (Linux, via `/sys/class/hwmon`). - **GPU usage / power draw** - Nvidia, AMD, and Intel. - **Battery** - Host system battery charge. - **Containers** - Status and metrics of all running Docker / Podman containers. - **S.M.A.R.T.** - Host system disk health (includes eMMC wear/EOL and Linux mdraid array health via sysfs when available). ## Help and discussion Please search existing issues and discussions before opening a new one. I try my best to respond, but may not always have time to do so. #### Bug reports and feature requests Bug reports and feature requests can be posted on [GitHub issues](https://github.com/henrygd/beszel/issues). #### Support and general discussion Support requests and general discussion can be posted on [GitHub discussions](https://github.com/henrygd/beszel/discussions) or the community-run [Matrix room](https://matrix.to/#/#beszel:matrix.org): `#beszel:matrix.org`. ## License Beszel is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. --- ## File: readme.md # Beszel Beszel is a lightweight server monitoring platform that includes Docker statistics, historical data, and alert functions. It has a friendly web interface, simple configuration, and is ready to use out of the box. It supports automatic backup, multi-user, OAuth authentication, and API access. [](https://hub.docker.com/r/henrygd/beszel-agent) [](https://hub.docker.com/r/henrygd/beszel) [](https://github.com/henrygd/beszel/blob/main/LICENSE) [](https://crowdin.com/project/beszel) ## Features - **Lightweight**: Smaller and less resource-intensive than leading solutions. - **Simple**: Easy setup with little manual configuration required. - **Docker stats**: Tracks CPU, memory, and network usage history for each container. - **Alerts**: Configurable alerts for CPU, memory, disk, bandwidth, temperature, fan speed, load average, and status. - **Multi-user**: Users manage their own systems. Admins can share systems across users. - **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled. - **Automatic backups**: Save to and restore from disk or S3-compatible storage. ## Architecture Beszel consists of two main components: the **hub** and the **agent**. - **Hub**: A web application built on [PocketBase](https://pocketbase.io/) that provides a dashboard for viewing and managing connected systems. - **Agent**: Runs on each system you want to monitor and communicates system metrics to the hub. ## Getting started The [quick start guide](https://beszel.dev/guide/getting-started) and other documentation is available on our website, [beszel.dev](https://beszel.dev). You'll be up and running in a few minutes. ## Screenshots ## Supported metrics - **CPU usage** - Host system and Docker / Podman containers. - **Memory usage** - Host system and containers. Includes swap and ZFS ARC. - **Disk usage** - Host system. Supports multiple partitions and devices. - **Disk I/O** - Host system. Supports multiple partitions and devices. - **Network usage** - Host system and containers. - **Load average** - Host system. - **Temperature** - Host system sensors. - **Fan speed** - Host system sensors (Linux, via `/sys/class/hwmon`). - **GPU usage / power draw** - Nvidia, AMD, and Intel. - **Battery** - Host system battery charge. - **Containers** - Status and metrics of all running Docker / Podman containers. - **S.M.A.R.T.** - Host system disk health (includes eMMC wear/EOL and Linux mdraid array health via sysfs when available). ## Help and discussion Please search existing issues and discussions before opening a new one. I try my best to respond, but may not always have time to do so. #### Bug reports and feature requests Bug reports and feature requests can be posted on [GitHub issues](https://github.com/henrygd/beszel/issues). #### Support and general discussion Support requests and general discussion can be posted on [GitHub discussions](https://github.com/henrygd/beszel/discussions) or the community-run [Matrix room](https://matrix.to/#/#beszel:matrix.org): `#beszel:matrix.org`. ## License Beszel is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. --- ## File: supplemental/guides/systemd.md # Installing as a Linux systemd service This is useful if you want to run the hub or agent in the background continuously, including after a reboot. ## Install script (recommended) There are two scripts, one for the hub and one for the agent. You can run either one, or both. The install script creates a dedicated user for the service (`beszel`), downloads the latest release, and installs the service. If you need to edit the service -- for instance, to change an environment variable -- you can edit the file(s) in `/etc/systemd/system/`. Then reload the systemd daemon and restart the service. > [!NOTE] > You need system administrator privileges to run the install script. If you encounter a problem, please [open an issue](https://github.com/henrygd/beszel/issues/new). ### Hub Download the script: ```bash curl -sL https://raw.githubusercontent.com/henrygd/beszel/main/supplemental/scripts/install-hub.sh -o install-hub.sh && chmod +x install-hub.sh ``` #### Install You may specify a port number with the `-p` flag. The default port is `8090`. ```bash ./install-hub.sh ``` #### Uninstall ```bash ./install-hub.sh -u ``` #### Update ```bash sudo /opt/beszel/beszel update && sudo systemctl restart beszel-hub ``` ### Agent Download the script: ```bash curl -sL https://raw.githubusercontent.com/henrygd/beszel/main/supplemental/scripts/install-agent.sh -o install-agent.sh && chmod +x install-agent.sh ``` #### Install You may optionally include the SSH key and port as arguments. Run `./install-agent.sh -h` for more info. If specifying your key with `-k`, please make sure to enclose it in quotes. ```bash ./install-agent.sh ``` #### Uninstall ```bash ./install-agent.sh -u ``` #### Update ```bash sudo /opt/beszel-agent/beszel-agent update && sudo systemctl restart beszel-agent ``` ## Manual install ### Hub 1. Create the system service at `/etc/systemd/system/beszel.service` ```bash [Unit] Description=Beszel Hub Service After=network.target [Service] # update the values in the curly braces below (remove the braces) ExecStart={/path/to/working/directory}/beszel serve WorkingDirectory={/path/to/working/directory} User={YOUR_USERNAME} Restart=always [Install] WantedBy=multi-user.target ``` 2. Start and enable the service to let it run after system boot ```bash sudo systemctl daemon-reload sudo systemctl enable beszel.service sudo systemctl start beszel.service ``` ### Agent 1. Create the system service at `/etc/systemd/system/beszel-agent.service` ```bash [Unit] Description=Beszel Agent Service After=network.target [Service] # update the values in curly braces below (remove the braces) Environment="PORT={PASTE_YOUR_PORT_HERE}" Environment="KEY={PASTE_YOUR_KEY_HERE}" # Environment="EXTRA_FILESYSTEMS={sdb}" ExecStart={/path/to/directory}/beszel-agent User={YOUR_USERNAME} Restart=always [Install] WantedBy=multi-user.target ``` 2. Start and enable the service to let it run after system boot ```bash sudo systemctl daemon-reload sudo systemctl enable beszel-agent.service sudo systemctl start beszel-agent.service ```