From b05966d30bdc6b8252350ce9877f7beb42acd273 Mon Sep 17 00:00:00 2001 From: henrygd Date: Mon, 26 May 2025 15:49:24 -0400 Subject: [PATCH] add help section to readme --- readme.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index 8922790..f6953cf 100644 --- a/readme.md +++ b/readme.md @@ -14,13 +14,13 @@ It has a friendly web interface, simple configuration, and is ready to use out o ## Features - **Lightweight**: Smaller and less resource-intensive than leading solutions. -- **Simple**: Easy setup, no need for public internet exposure. +- **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, 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 and restore data from disk or S3-compatible storage. -- **REST API**: Use or update your data in your own scripts and applications. +- **Automatic backups**: Save to and restore from disk or S3-compatible storage. + ## Architecture @@ -49,14 +49,17 @@ The [quick start guide](https://beszel.dev/guide/getting-started) and other docu - **Temperature** - Host system sensors. - **GPU usage / temperature / power draw** - Nvidia and AMD only. Must use binary agent. -## Discussion and reporting issues +## Help and discussion -- Report issues on the [GitHub issues page](https://github.com/henrygd/beszel/issues) -- Contact developers on [the GitHub discussions page](https://github.com/henrygd/beszel/discussions) or the community in the Matrix room **#beszel:matrix.org** +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. -## Support +#### Bug reports and feature requests +Bug reports and detailed feature requests should 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