From ddfcbc546bc944bf08260a849e3240bdc958c8b7 Mon Sep 17 00:00:00 2001 From: Henry Dollman Date: Mon, 16 Sep 2024 14:05:00 -0400 Subject: [PATCH] release 0.4.0 --- beszel/version.go | 2 +- readme.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/beszel/version.go b/beszel/version.go index 794daf5..296400d 100644 --- a/beszel/version.go +++ b/beszel/version.go @@ -1,6 +1,6 @@ package beszel const ( - Version = "0.3.0" + Version = "0.4.0" AppName = "beszel" ) diff --git a/readme.md b/readme.md index 2825e64..4732fb2 100644 --- a/readme.md +++ b/readme.md @@ -10,13 +10,13 @@ A lightweight server resource monitoring hub with historical data, docker stats, ## Features - **Lightweight**: Smaller and less resource-intensive than leading solutions. -- **Docker stats**: Tracks CPU and memory usage history for each container. +- **Simple**: Easy setup, no need for public internet exposure. +- **Docker stats**: Tracks CPU, memory, and network usage history for each container. - **Alerts**: Configurable alerts for CPU, memory, disk usage, and system status. - **Multi-user**: Each user manages their own systems. Admins can share systems across users. -- **Simple**: Easy setup, no need for public internet exposure. - **OAuth / OIDC**: Supports multiple OAuth2 providers. Password authentication can be disabled. - **Automatic backups**: Save and restore data from disk or S3-compatible storage. -- **REST API**: Integrate your metrics into your own scripts and applications. +- **REST API**: Use or update your data in your own scripts and applications. ## Introduction @@ -108,10 +108,13 @@ Use `./beszel update` and `./beszel-agent update` to update to the latest versio | ------------------- | ------- | ---------------------------------------------------------------------------------------- | | `DOCKER_HOST` | unset | Overrides the docker host (docker.sock) if using a proxy.[^socket] | | `EXTRA_FILESYSTEMS` | unset | See [Monitoring additional disks / partitions](#monitoring-additional-disks--partitions) | -| `FILESYSTEM` | unset | Device or partition to use for root disk I/O stats. | +| `FILESYSTEM` | unset | Device, partition, or mount point to use for root disk stats. | | `KEY` | unset | Public SSH key to use for authentication. Provided in hub. | +| `NICS` | unset | Whitelist of network interfaces to monitor for bandwidth chart. | | `PORT` | 45876 | Port or address:port to listen on. | + + [^socket]: Beszel only needs access to read container information. For [linuxserver/docker-socket-proxy](https://github.com/linuxserver/docker-socket-proxy) you would set `CONTAINERS=1`. ## OAuth / OIDC Setup @@ -150,9 +153,6 @@ Visit the "Auth providers" page to enable your provider. The redirect / callback ## Monitoring additional disks / partitions -> [!NOTE] -> This feature is new and has been tested on a limited number of systems. Please report any issues. - You can configure the agent to monitor the usage and I/O of more than one disk or partition. The approach differs depending on the deployment method. Use `lsblk` to find the names and mount points of your partitions. If you have trouble, check the agent logs. @@ -224,7 +224,7 @@ Otherwise, use the agent's `container_name` as the hostname if both are in the s ### Finding the correct filesystem -Specify the filesystem/device/partition for disk I/O stats using the `FILESYSTEM` environment variable. +Specify the filesystem/device/partition for root disk stats using the `FILESYSTEM` environment variable. If not set, the agent will try to find the partition mounted on `/` and use that. This may not work correctly in a container, so it's recommended to set this value. Use one of the following methods to find the correct filesystem: