Add native Pocket ID OIDC tutorials across the app guides
This commit is contained in:
@@ -116,7 +116,7 @@ In the Swag folders, create the `pingvin.subdomain.conf` file.
|
||||
|
||||
::tip{icon=""}
|
||||
|
||||
✨ __Tip:__ you can use [File Browser](/serveex/files/file-browser) to browse your files and edit your documents instead of using terminal commands.
|
||||
✨ __Tip:__ you can use [File Browser Quantum](/serveex/files/file-browser-quantum) to browse your files and edit your documents instead of using terminal commands.
|
||||
::
|
||||
|
||||
```bash [Terminal]
|
||||
@@ -180,9 +180,35 @@ Press :kbd{value="Ctrl+O"}, then :kbd{value="Enter"} to save, and :kbd{value="Ct
|
||||
|
||||
That's it, you've exposed Pingvin!
|
||||
|
||||
## Securing Pingvin with Authentik
|
||||
## Protecting Pingvin with Pocket ID
|
||||
Pingvin supports OIDC natively, so you can require a Pocket ID login before letting anyone share or receive files, instead of (or alongside) the app's own accounts.
|
||||
|
||||
You can protect this app natively via OIDC with [Pocket ID](/serveex/security/pocket-id#registering-an-oidc-client) instead (register Pingvin as an OIDC client there, then fill in Pingvin's OAuth settings the same way as step 6 below), or with Authentik by following the instructions below.
|
||||
::steps{level="3"}
|
||||
### Register Pingvin as an OIDC client
|
||||
|
||||
[Register an OIDC client in Pocket ID](/serveex/security/pocket-id#registering-an-oidc-client) named `pingvin`, with this callback URL:
|
||||
|
||||
```text
|
||||
https://pingvin.yourdomain.com/api/oauth/callback/oidc
|
||||
```
|
||||
|
||||
### Enable Social Login in Pingvin
|
||||
|
||||
In Pingvin, go to _Administration > Configuration > Social Login_ and fill in:
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| OpenID Connect | Enabled |
|
||||
| Discovery URI | Pocket ID's OIDC discovery URL |
|
||||
| Scope | `openid email profile groups` |
|
||||
|
||||
### Done !
|
||||
::
|
||||
|
||||
That's it! From now on, when you log in to Pingvin, an "Open ID" button will be available below the login form.
|
||||
|
||||
::tip
|
||||
✨ You can use [Authentik](/serveex/advanced/authentik) instead of Pocket ID:
|
||||
|
||||
1. In your Authentik admin area, create an OAuth2/OpenID provider.
|
||||
|
||||
@@ -205,5 +231,4 @@ You can protect this app natively via OIDC with [Pocket ID](/serveex/security/po
|
||||
- `OpenID username claim` with `preferred_username`
|
||||
- `OpenID client ID` with the ID you copied in step 2.
|
||||
- `OpenID client secret` with the token you copied in step 2.
|
||||
|
||||
That's it! From now on, when you log in to Pingvin, an "Open ID" button will be available below the login form.
|
||||
::
|
||||
|
||||
Reference in New Issue
Block a user