From aa62765227bb1662030241fe2b7849c444b6c70f Mon Sep 17 00:00:00 2001 From: Mr72PS Date: Sat, 9 May 2026 06:40:54 +0200 Subject: [PATCH 1/3] Create dbackup.md I created the client example for DBackup- --- docs/client-examples/dbackup.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/client-examples/dbackup.md diff --git a/docs/client-examples/dbackup.md b/docs/client-examples/dbackup.md new file mode 100644 index 0000000..0df7a9b --- /dev/null +++ b/docs/client-examples/dbackup.md @@ -0,0 +1,32 @@ +## Create the DBackup OIDC Client in PocketID + +### Required Settings + +- **Callback-URL:** `https://your-dbackup-url/api/auth/sso/callback/{provider-id}` +- **Grant Type:** `Authorization Code` +- **Scopes:** `openid`, `profile`, `email` + +Attention: The {provider-id} must be the Provider ID you get when creating the SSO/OIDC settings in DBackup. DBackup will propose an ID, e.g. pocket-id-1234 + +The Callback-URL in a local docker installation of DBackup can also be the local IP address and the port of DBackup, for example 'https://192.168.x.xxx:3000/api/auth/sso/callback/pocket-id-123' + +### Copy the ID and Client Secret from PocketID + +- **Client ID** +- **Client Secret** + +--- + +## Configuration of PocketID in DBackup + +The SSO settings in DBackup are in the menu of Users & Groups and then SSO / OIDC + +### Configuration + +| Field | Description | Example | +|---|---|---| +| Name | Display name | `"PocketID"` | +| Provider ID | The ID to be used in the client configuration in PocketID | `pocket-id-1234` | +| Provider | PocketID URL | `https://pocketid.example.com` | +| Client ID | From PocketID | `client-id` | +| Client Secret | From PocketID | `secret` | From b39ce153d715834122d0c99ba3e3a90860f397ea Mon Sep 17 00:00:00 2001 From: Mr72PS Date: Sat, 9 May 2026 06:48:07 +0200 Subject: [PATCH 2/3] Create readmeabook.md The documentation for the OIDC client for ReadMeABook --- docs/client-examples/readmeabook.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/client-examples/readmeabook.md diff --git a/docs/client-examples/readmeabook.md b/docs/client-examples/readmeabook.md new file mode 100644 index 0000000..a39af2d --- /dev/null +++ b/docs/client-examples/readmeabook.md @@ -0,0 +1,24 @@ +## Create in PocketID an OIDC Client for ReadMeABook + +### Required Settings in PocketID to create the OIDC Client +- **Redirect URI:** `https://your.rmab.domain.com/api/auth/oidc/callback)` +- **Grant Type:** `Authorization Code` +- **Scopes:** `openid`, `profile`, `email` + +### Obtain + +- **Client ID** +- **Client Secret** + +--- + +## Configuration of PocketID in RMAB + +### Configuration + +| Field | Description | Example | +|---|---|---| +| Provider Name | Display Name | `PocketID` | +| Issuer URL | PocketID instance URL | `https://pocketid.example.com/.well-known/openid-configuration` | +| Client ID | From PocketID | `client-id` | +| Client Secret | From PocketID | `secret` | From 73c6cf6c2746a0596d301507786954d53273006e Mon Sep 17 00:00:00 2001 From: Mr72PS Date: Sat, 23 May 2026 07:02:05 +0200 Subject: [PATCH 3/3] docs: settings for Dockhand The settings to use Pocket ID for Dockhand, a modern, powerful Docker management application. --- docs/client-examples/dockhand.md | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/client-examples/dockhand.md diff --git a/docs/client-examples/dockhand.md b/docs/client-examples/dockhand.md new file mode 100644 index 0000000..0e02a64 --- /dev/null +++ b/docs/client-examples/dockhand.md @@ -0,0 +1,36 @@ +## Create the Dockhand OIDC Client in PocketID + +### Required Settings + +- **Callback-URL:** `https://your-dockhand-url/api/auth/oidc/callback` +- **Grant Type:** `Authorization Code` +- **Scopes:** `openid`, `profile`, `email` + +The Callback-URL in a local docker installation of Dockhand can also be the local IP address with http and the port of Dockhand, for example 'http://192.168.x.xxx:3866/api/auth/oidc/callback' + +### Copy the ID and Client Secret from PocketID + +- **Client ID** +- **Client Secret** + +--- + +## Configuration of PocketID in Dockhand + +The SSO settings in Dockhand are in the Settings menu of Authentication and then SSO / OIDC and then +Add Provider + +### Configuration + +| Field | Description | Example | +|---|---|---| +| Name | Display name | `"PocketID"` | +| Issuer URL | The URL of PocketID | `https://pocketid.example.com` | +| Client ID | From PocketID | `client-id` | +| Client Secret | From PocketID | `secret` | +| Redirect URI | Dockhand Callback URL from Pocket ID | `https://your-dockhand-url/api/auth/oidc/callback` | +| Scopes | Scopes from PocketID | openid profile email | +| Username claim | Username claim | preferred_username | +| Email claim | Email claim | email | +| Display name claim | Display name claim | name | + +Attention: When accessing a local Dockhand installation, then the Callback URL in the Dockhand SSO / OIDC settings can be 'http://192.168.x.xxx:3866/api/auth/oidc/callback' without https!