fankes/beszel
2
0
Fork 0
mirror of https://github.com/fankes/beszel.git synced 2025-10-19 09:49:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Henry Dollman
2024-07-22 19:01:05 -04:00
parent 14c7e2db8f
commit 5ba7568acf
1 changed files with 11 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
readme.md
View File

@@ -1,28 +1,22 @@
# Beszel \*WIP\* # Beszel
A lightweight server resource monitoring hub with historical data, docker stats, and alerts. A lightweight server resource monitoring hub with historical data, docker stats, and alerts.
<!-- <table width="100%"> [![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)
<tbody> [![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)
<tr>
<td width="50%"><img src="https://henrygd-assets.b-cdn.net/social-image-server/before-capture.png" alt="example of turso.tech/pricing link which is missing an og:image as of may 11 2024"/></td>
<td width="50%"><img src="https://henrygd-assets.b-cdn.net/social-image-server/after-capture.webp" alt="example of turso.tech/pricing link using an image generated by the server as it's og:image"/></td>
</tr>
</tbody>
</table> -->
<!-- ## Features ![Screenshot of the hub](https://henrygd-assets.b-cdn.net/beszel/screenshot.png?)
## Features
- **Lightweight**: Much smaller and less demanding than leading solutions. - **Lightweight**: Much smaller and less demanding than leading solutions.
- **Historical data**: Stats are available for up to 30 days.
- **Docker stats**: CPU and memory usage history for each container. - **Docker stats**: CPU and memory usage history for each container.
- **Alerts**: Lorem ipsum dolor sit amet, consectetur adipiscing elit. - **Alerts**: Configurable alerts for CPU, memory, and disk usage, and system status.
- **Simple**: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
- **Multi-user**: Each user has their own systems. Admins can share systems across users. - **Multi-user**: Each user has their own systems. Admins can share systems across users.
- **Secure**: Lorem ipsum dolor sit amet, consectetur adipiscing elit. - **Simple**: Easy setup and doesn't require anything to be publicly available online.
- **Oauth / OIDC**: Supports many OAuth2 providers and password auth can be disabled. - **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled.
- **Automated backups**: Automatically back up your data to S3-compatible storage. - **Automated backups**: Automatically back up your data to disk or S3-compatible storage.
- **Open source**: MIT license and no paywalled features. --> - **REST API**: Pull your metrics to use in your own scripts and applications.
## Introduction ## 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. 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 ## Getting started
If using the binary instead of docker, ignore 4-5 and run the agent using the binary instead. If using the binary instead of docker, ignore 4-5 and run the agent using the binary instead.