From 5ba7568acfc8c45ef744ba918e0083e016dde733 Mon Sep 17 00:00:00 2001 From: Henry Dollman Date: Mon, 22 Jul 2024 19:01:05 -0400 Subject: [PATCH] update readme --- readme.md | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/readme.md b/readme.md index b36ed5b..6c943bf 100644 --- a/readme.md +++ b/readme.md @@ -1,28 +1,22 @@ -# Beszel \*WIP\* +# Beszel A lightweight server resource monitoring hub with historical data, docker stats, and alerts. - +[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel-agent/0.0.1-alpha.6?logo=docker&label=agent%20image%20size)](https://hub.docker.com/r/henrygd/beszel-agent) +[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel/0.0.1-alpha.6?logo=docker&label=hub%20image%20size)](https://hub.docker.com/r/henrygd/beszel) - +- **Simple**: Easy setup and doesn't require anything to be publicly available online. +- **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled. +- **Automated backups**: Automatically back up your data to disk or S3-compatible storage. +- **REST API**: Pull your metrics to use in your own scripts and applications. ## Introduction @@ -32,9 +26,6 @@ The hub is a web application that provides a dashboard to view and manage your c 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. -[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel-agent/0.0.1-alpha.3?logo=docker&label=agent%20image%20size)](https://hub.docker.com/r/henrygd/beszel-agent) -[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel/0.0.1-alpha.3?logo=docker&label=hub%20image%20size)](https://hub.docker.com/r/henrygd/beszel) - ## Getting started If using the binary instead of docker, ignore 4-5 and run the agent using the binary instead.