Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions docs/client-examples/dbackup.md
Original file line number Diff line number Diff line change
@@ -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` |
36 changes: 36 additions & 0 deletions docs/client-examples/dockhand.md
Original file line number Diff line number Diff line change
@@ -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!
24 changes: 24 additions & 0 deletions docs/client-examples/readmeabook.md
Original file line number Diff line number Diff line change
@@ -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` |
Loading