From 52c77dd361bec6333d350612e25a8c4f3251da70 Mon Sep 17 00:00:00 2001 From: Henry Dollman Date: Tue, 23 Jul 2024 18:51:49 -0400 Subject: [PATCH] readme / site style updates --- .../src/components/charts/bandwidth-chart.tsx | 3 ++- hub/site/src/components/charts/disk-chart.tsx | 3 ++- .../src/components/charts/disk-io-chart.tsx | 3 ++- .../systems-table/systems-table.tsx | 2 +- readme.md | 27 +++++++++++++++++-- 5 files changed, 32 insertions(+), 6 deletions(-) diff --git a/hub/site/src/components/charts/bandwidth-chart.tsx b/hub/site/src/components/charts/bandwidth-chart.tsx index 5819036..dca13ee 100644 --- a/hub/site/src/components/charts/bandwidth-chart.tsx +++ b/hub/site/src/components/charts/bandwidth-chart.tsx @@ -72,7 +72,8 @@ export default function BandwidthChart({ tickFormatter={hourWithMinutes} /> {flexRender(cell.column.columnDef.cell, cell.getContext())} diff --git a/readme.md b/readme.md index aa910ec..f3f2797 100644 --- a/readme.md +++ b/readme.md @@ -95,8 +95,9 @@ Use `beszel update` and `beszel-agent update` to update to the latest version. Beszel supports OpenID Connect and many OAuth2 authentication providers (see list below). To enable, do the following: -1. Create an OAuth2 application using your provider of choice. The redirect / callback URL should be `/api/oauth2-redirect`. -2. When you have the client ID and secret, go to the "Auth providers" page and enable your provider. +1. Make sure your "Application URL" is set correctly in the PocketBase settings. +2. Create an OAuth2 application using your provider of choice. The redirect / callback URL should be `/api/oauth2-redirect`. +3. When you have the client ID and secret, go to the "Auth providers" page and enable your provider.
Supported provider list @@ -137,6 +138,24 @@ When the hub is started for the first time, it generates an ED25519 key pair. The agent's SSH server is configured to accept connections only using this key. It does not provide a pty or accept any input, so it is not possible to execute commands on the agent even if your private key is compromised. +## User roles + +### Admin + +Assumed to have an admin account in PocketBase, so links to backups, SMTP settings, etc., are shown in the hub. + +The first user created automatically becomes an admin and can log into PocketBase. + +Please note that changing a user's role will not create a PocketBase admin account for them. If you want to do that, go to Settings > Admins in PocketBase and add them there. + +### User + +Can create their own systems and alerts. Links to PocketBase settings are not shown in the hub. + +### Read only + +Cannot create systems, but can view any system that has been shared with them by an admin. Can create alerts. + ## FAQ / Troubleshooting ### Agent is not connecting @@ -155,6 +174,10 @@ If it's not set, the agent will try to find the filesystem mounted on `/` and us - Run `lsblk` and choose an option under "NAME" - Run `sudo fdisk -l` and choose an option under "Device" +### Docker containers are not populating reliably + +Try upgrading your docker version on the agent system. I had this issue on a machine running docker 24. It was fixed by upgrading to version 27. + ### Month / week records are not populating reliably Records for longer time periods are made by averaging stats from the shorter time periods. They require the agent to be running uninterrupted for long enough to get a full set of data.