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

add help section to readme

Browse Source
This commit is contained in:
henrygd
2025-05-26 15:49:24 -04:00
parent ea90f6a596
commit b05966d30b
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
readme.md
View File

@@ -14,13 +14,13 @@ It has a friendly web interface, simple configuration, and is ready to use out o
## Features ## Features
- **Lightweight**: Smaller and less resource-intensive than leading solutions. - **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. - **Docker stats**: Tracks CPU, memory, and network usage history for each container.
- **Alerts**: Configurable alerts for CPU, memory, disk, bandwidth, temperature, and status. - **Alerts**: Configurable alerts for CPU, memory, disk, bandwidth, temperature, and status.
- **Multi-user**: Users manage their own systems. Admins can share systems across users. - **Multi-user**: Users manage their own systems. Admins can share systems across users.
- **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled. - **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled.
- **Automatic backups**: Save and restore data from disk or S3-compatible storage. - **Automatic backups**: Save to and restore from disk or S3-compatible storage.
- **REST API**: Use or update your data in your own scripts and applications. <!-- - **REST API**: Use or update your data in your own scripts and applications. -->
## Architecture ## Architecture
@@ -49,14 +49,17 @@ The [quick start guide](https://beszel.dev/guide/getting-started) and other docu
- **Temperature** - Host system sensors. - **Temperature** - Host system sensors.
- **GPU usage / temperature / power draw** - Nvidia and AMD only. Must use binary agent. - **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) 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.
- Contact developers on [the GitHub discussions page](https://github.com/henrygd/beszel/discussions) or the community in the Matrix room **#beszel:matrix.org**
## 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 ## License