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

update readme

Browse Source
This commit is contained in:
Henry Dollman
2024-08-06 15:13:06 -04:00
parent b8a2d0f32f
commit f4e82ecd59
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@@ -45,7 +45,7 @@ Pour le tutoriel en français, consultez https://belginux.com/installer-beszel-a
## Installation ## Installation
You may choose to install the hub and agent as single binaries, or as docker images. You may install the hub and agent as single binaries, or by using Docker.
### Docker ### Docker
@@ -108,18 +108,16 @@ Use `./beszel update` and `./beszel-agent update` to update to the latest versio
| ------------ | ------- | ---------------------------------------------------------- | | ------------ | ------- | ---------------------------------------------------------- |
| `FILESYSTEM` | unset | Filesystem / partition to use for disk I/O stats. | | `FILESYSTEM` | unset | Filesystem / partition to use for disk I/O stats. |
| `KEY` | unset | Public SSH key to use for authentication. Provided in hub. | | `KEY` | unset | Public SSH key to use for authentication. Provided in hub. |
| `PORT` | 45876 | Port to listen on. | | `PORT` | 45876 | Port or address:port to listen on. |
<!-- | `DOCKER_HOST` | unset | Overrides the docker host (docker.sock) if using a proxy.[^socket] | <!-- | `DOCKER_HOST` | unset | Overrides the docker host (docker.sock) if using a proxy.[^socket] |
[^socket]: Beszel only needs access to read container information. For [linuxserver/docker-socket-proxy](https://github.com/linuxserver/docker-socket-proxy) you would set `CONTAINERS=1`. --> [^socket]: Beszel only needs access to read container information. For [linuxserver/docker-socket-proxy](https://github.com/linuxserver/docker-socket-proxy) you would set `CONTAINERS=1`. -->
## OAuth / OIDC setup ## OAuth / OIDC setup
Beszel supports OpenID Connect and many OAuth2 authentication providers (see list below). To enable, do the following: Beszel supports OpenID Connect and many OAuth2 authentication providers (see list below).
1. Make sure your "Application URL" is set correctly in the PocketBase settings. Visit the "Auth providers" page to enable your provider. The redirect / callback URL should be `<your-beszel-url>/api/oauth2-redirect`.
2. Create an OAuth2 application using your provider of choice. The redirect / callback URL should be `<your-beszel-url>/api/oauth2-redirect`.
3. When you have the client ID and secret, go to the "Auth providers" page and enable your provider.
<details> <details>
<summary>Supported provider list</summary> <summary>Supported provider list</summary>