-
-
Notifications
You must be signed in to change notification settings - Fork 131
Add PocketID Instruction manual #221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Greptile OverviewGreptile SummaryThis PR adds comprehensive documentation for PocketID OAuth integration, introducing a new guide that helps users set up decentralized authentication with their Remnawave Panel. The documentation follows the established pattern seen in other OAuth guides (like telegram-oauth.md) with front matter, preview images, and step-by-step instructions covering both the PocketID service setup and the panel configuration. The guide walks users through creating OAuth clients in PocketID, configuring callback URLs, obtaining client credentials, and enabling the authentication method in their panel settings. This addition expands the authentication options available to users by documenting support for PocketID's decentralized identity protocol. Important Files Changed
Confidence score: 2/5
Sequence DiagramsequenceDiagram
participant User
participant "Remnawave Panel" as Panel
participant "PocketID Server" as PocketID
participant Database as DB
User->>Panel: "Navigate to Settings → PocketID"
Panel->>User: "Display PocketID configuration form"
User->>Panel: "Enter Client ID, Client Secret, Domain, Allowed Emails"
Panel->>DB: "Save PocketID configuration"
DB-->>Panel: "Configuration saved"
Panel->>User: "Configuration saved successfully"
Note over PocketID: Administrator configures OIDC Client
User->>Panel: "Click PocketID login button"
Panel->>PocketID: "Redirect to PocketID OAuth endpoint with Client ID"
PocketID->>User: "Display PocketID login form"
User->>PocketID: "Enter credentials and authenticate"
PocketID->>PocketID: "Validate credentials and check allowed emails"
PocketID->>Panel: "Redirect to callback URL with authorization code"
Panel->>PocketID: "Exchange authorization code for access token"
PocketID-->>Panel: "Return access token and user info"
Panel->>Panel: "Validate user email against allowed emails list"
Panel->>DB: "Create/update user session"
DB-->>Panel: "Session created"
Panel->>User: "Redirect to dashboard (authenticated)"
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 2 comments
|
|
||
| ### Setting up | ||
|
|
||
| 1. Open Remnawave Panel and move to `Settings` -> `Telegram`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Navigation error: should direct users to Settings -> PocketID, not Settings -> Telegram
| 4. Save the settings. | ||
|
|
||
| :::warning | ||
| Do not turn on `Puclic cient` and `PKCE` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
syntax: Spelling error: 'Puclic cient' should be 'Public client'
| Do not turn on `Puclic cient` and `PKCE` | |
| Do not turn on `Public client` and `PKCE` |
No description provided.