nikdoof/pocket-id
1
0
Fork 0
mirror of https://github.com/nikdoof/pocket-id.git synced 2025-12-14 07:12:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typos and improve clarity in proxmox.md (#183)

Browse Source
This commit is contained in:
Daniel Breedeveld
2025-01-27 16:02:55 +08:00
committed by GitHub
parent a879bfa418
commit 4a97986f52
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docs/client-examples/proxmox.md
View File

@@ -4,27 +4,27 @@ id: proxmox
# 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.) - `proxmox.example.com` (The URL of your Proxmox instance.)
- id.example.com (The url of your Pocket ID instance.) - `id.example.com` (The URL of your Pocket ID instance.)
## Pocket ID Setup ## Pocket ID Setup
1. In Pocket-ID create a new OIDC Client, name it i.e. `Proxmox`. 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 too. 2. Set a logo for this OIDC Client if you would like to.
3. Set the callback URL to: `https://proxmox.example.com`. 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. 4. Copy the `Client ID`, and the `Client Secret` for use in the next steps.
## Proxmox Setup ## Proxmox Setup
1. Open the Proxmox Console and navigate to: `Datacenter - Realms` 1. Open the Proxmox console and navigate to: `Datacenter` -> `Permissions` -> `Realms`.
2. Add a new `Open ID Connect Server` Realm 2. Add a new `OpenID Connect Server` Realm.
3. Enter `https://id.example.com` for the `Issuer URL` 3. Enter `https://id.example.com` for the `Issuer URL`.
4. Enter a name for the realm of your choice ie. `PocketID` 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. 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. 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. 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 automaitcally create users in Proxmox if they dont exsist.) 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 personal preference and controls how the username is shown, ie: `username = username@PocketID` or `email = username@example@PocketID`). 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. 10. Leave the rest as defaults and click `OK` to save the new realm.