From 4a97986f5235623814e65c356af5d4d4c5a7e0b5 Mon Sep 17 00:00:00 2001 From: Daniel Breedeveld Date: Mon, 27 Jan 2025 16:02:55 +0800 Subject: [PATCH] docs: fix typos and improve clarity in proxmox.md (#183) --- docs/docs/client-examples/proxmox.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/docs/client-examples/proxmox.md b/docs/docs/client-examples/proxmox.md index 4f508deb..8c3698b6 100644 --- a/docs/docs/client-examples/proxmox.md +++ b/docs/docs/client-examples/proxmox.md @@ -4,27 +4,27 @@ id: proxmox # Proxmox -The following example variables are used, and should be replaced with your actual URLS. +The following example variables are used, and should be replaced with your actual URLs. -- proxmox.example.com (The url of your proxmox instance.) -- id.example.com (The url of your Pocket ID instance.) +- `proxmox.example.com` (The URL of your Proxmox instance.) +- `id.example.com` (The URL of your Pocket ID instance.) ## Pocket ID Setup -1. In Pocket-ID create a new OIDC Client, name it i.e. `Proxmox`. -2. Set a logo for this OIDC Client if you would like too. +1. In Pocket ID create a new OIDC Client, name it, for example, `Proxmox`. +2. Set a logo for this OIDC Client if you would like to. 3. Set the callback URL to: `https://proxmox.example.com`. 4. Copy the `Client ID`, and the `Client Secret` for use in the next steps. ## Proxmox Setup -1. Open the Proxmox Console and navigate to: `Datacenter - Realms` -2. Add a new `Open ID Connect Server` Realm -3. Enter `https://id.example.com` for the `Issuer URL` -4. Enter a name for the realm of your choice ie. `PocketID` +1. Open the Proxmox console and navigate to: `Datacenter` -> `Permissions` -> `Realms`. +2. Add a new `OpenID Connect Server` Realm. +3. Enter `https://id.example.com` for the `Issuer URL`. +4. Enter a name for the realm of your choice, for example, `PocketID`. 5. Paste the `Client ID` from Pocket ID into the `Client ID` field in Proxmox. 6. Paste the `Client Secret` from Pocket ID into the `Client Key` field in Proxmox. -7. You can check the `Default` box if you want this to be the deafult realm proxmox uses when signing in. -8. Check the `Autocreate Users` checkbox. (This will automaitcally create users in Proxmox if they dont exsist.) -9. Select `username` for the `Username Claim` dropdown (This is personal preference and controls how the username is shown, ie: `username = username@PocketID` or `email = username@example@PocketID`). +7. You can check the `Default` box if you want this to be the default realm Proxmox uses when signing in. +8. Check the `Autocreate Users` checkbox. (This will automatically create users in Proxmox if they don't exist). +9. Select `username` for the `Username Claim` dropdown. (This is a personal preference and controls how the username is shown, for example: `username = username@PocketID` or `email = username@example@PocketID`). 10. Leave the rest as defaults and click `OK` to save the new realm.