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

website/integrations: Beszel #12905

Merged
merged 12 commits into from
Mar 18, 2025
Merged

website/integrations: Beszel #12905

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d69ebbf
initial release
nicedevil007 Jan 31, 2025
849a319
Ready for PR
nicedevil007 Jan 31, 2025
9d1da7b
never changed this?
nicedevil007 Jan 31, 2025
d24553e
reference to PocketBase
nicedevil007 Feb 2, 2025
b82097f
index.mdx aktualisieren
nicedevil007 Mar 6, 2025
76d045f
index.mdx aktualisieren
nicedevil007 Mar 6, 2025
2d90c94
index.mdx aktualisieren
nicedevil007 Mar 6, 2025
8d231df
add full instructions
Mar 14, 2025
8a4ea85
add Beszel config
Mar 14, 2025
0ab0cd5
Update website/integrations/services/beszel/index.mdx
tanberry Mar 14, 2025
82eadd4
Update website/integrations/services/beszel/index.mdx
tanberry Mar 14, 2025
bcaea2e
correct redirect URI
nicedevil007 Mar 14, 2025
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
52 changes: 52 additions & 0 deletions website/integrations/services/beszel/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Integrate with Beszel
sidebar_label: Beszel
---

# Integrate With Beszel

<span class="badge badge--secondary">Support level: Community</span>

## What is Beszel

> Beszel is a lightweight server monitoring platform that provides Docker statistics, historical data, and configurable alerts.
> It features a user-friendly web interface, supports multi-user management, OAuth authentication, and offers a REST API for integration with other applications.
> Designed for simplicity, Beszel is easy to set up and operates efficiently without requiring public internet exposure.
>
> -- https://beszel.dev/
>
> This guide explains how to configure Beszel to use authentik as the OAuth provider for logging in to the Web GUI.

## Preparation

Since Beszel uses PocketBase as its backend, you only need to replace the PocketBase placeholders with the placeholders found on this page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to more clearly explain the dependencies between PB and Beszel. And, even though it is not great to have to duplicate content, I don't think we should ask readers to have to go read other docs (the PB docs). I'll make a pass at a compromise idea.. we can see how it looks.

Question: does a user have to also configure PB as part of this Beszel setup? Or if they already set up PB before, do they not need to do anything?

Copy link
Contributor Author

@nicedevil007 nicedevil007 Mar 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You install Beszel and it already comes with Pocketbase installed as its backend, no need for separate setup steps to get Pocketbase Running.

First I did a Guide on only Beszel and the Suggestion was to create a seperate Pocketbase doc so wie can reference to this one because the setup will always be the same of Pocketbase is Süd as the backend.

So how to make it more easy for endusers... I Hope you have good idea 😁

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh oh, so two possibilities:

  • IF they already have integrated PB, they still have to also do these steps for Beszel (basically the same steps as for PB but diff FQDNs of course),

  • if they have not yet installed PB, and they want to install Beszel, then they DO NOT have to also install PB also. It will come with the PB integration.

Is this correct @nicedevil007 ? Thank you for your bravery and patience... :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is correct, I followed the comment here to split those up,. If I have to revert back to the only Beszel Docs without pocketbase I have to say sorry, we close this then and I don't know who I can trust on advices here anymore :(

#12905 (review)

You can find the PocketBase documentation here: https://docs.goauthentik.io/integrations/services/pocketbase/.

- `beszel.company` is the FQDN of the Beszel installation.
- `authentik.company` is the FQDN of the authentik installation.
- `Beszel` is the Name of the authentik application.
- `beszel` is the Slug of the authentik application.

:::note
This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.
:::

## Test the login

- Open your web browser and go to: <kbd>https://<em>beszel.company</em></kbd>.
- Click **authentik** to log in.
- You should be redirected to authentik (following the login flow you configured). After logging in, authentik will redirect you back to <kbd>https://<em>beszel.company</em></kbd>.
- If you successfully return to the Beszel WebGUI, the login is working correctly.

## User Creation

1. Manually Creating Users:

- Users are not created automatically when logging in with authentik. The owner must manually create each user in Beszel.
- To create users, go to the System Settings where you configured OpenID Connect.
- The URL for user creation is: <kbd>https://<em>beszel.company</em>>/\_/#/collections?collection=pb_users_auth</kbd>.
- Click **+ New record** and enter the user's **email** (must match the authentik email address).

2. Automatically Creating Users:
- Set the following environment variable: **USER_CREATION=true**
- Depending on your deployment method, you can set this as a Docker environment variable or in the systemd service file.
1 change: 1 addition & 0 deletions website/sidebarsIntegrations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ module.exports = {
type: "category",
label: "Monitoring",
items: [
"services/beszel/index",
"services/chronograf/index",
"services/gatus/index",
"services/glitchtip/index",
Expand Down
Loading