Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: corrections Beszel widget docs #4282

Merged
merged 4 commits into from
Nov 12, 2024
Merged

Documentation: corrections Beszel widget docs #4282

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a46c97
Improved beszel documentation
abey Nov 12, 2024
9067265
Update beszel.md
shamoon Nov 12, 2024
a9d65d1
Update docs/widgets/services/beszel.md
shamoon Nov 12, 2024
23974aa
Update beszel.md
shamoon Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/widgets/services/beszel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Beszel
description: Beszel Widget Configuration
---

Learn more about [Beszel]()
Learn more about [Beszel](https://github.com/henrygd/beszel)

The widget has two modes, a single system with detailed info if `systemId` is provided, or an overview of all systems if `systemId` is not provided.
The widget has two modes, a single system with detailed info if `systemId` is provided, or an overview of all systems if `systemId` is not provided. Note: `systemId` is not the system name. Find the correct ID in the list at `http://beszel.host.or.ip/_/#/collections` under the `id` field.
shamoon marked this conversation as resolved.
Show resolved Hide resolved

Allowed fields for 'overview' mode: `["systems", "up"]`
Allowed fields for a single system: `["name", "status", "updated", "cpu", "memory", "disk", "network"]`
Expand All @@ -18,3 +18,13 @@ widget:
password: password
systemId: systemId # optional
```

To show specific fields for a single system (up to a maximum of 4), add a `fields` to the widget config above. For example:

```yaml
fields:
- cpu
- memory
- disk
- network
```