-
Notifications
You must be signed in to change notification settings - Fork 10
Authentik SSO Instruction Clarity #1591
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
Conversation
Change hard coded application slug to <application_slug> to show this needs to be changed.
WalkthroughDocumentation updated: In the OIDC provider setup for Authentik, the Issuer URL example now uses a dynamic <application_slug> placeholder instead of a fixed unraid-api path. No code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
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.
Actionable comments posted: 0
🧹 Nitpick comments (2)
api/docs/public/oidc-provider-setup.md (2)
399-405: Add a brief note on where to find the application slug (and keep the trailing slash).Small clarity boost: explicitly tell users where to locate the slug in Authentik and remind them to keep the trailing slash, which is required for discovery.
Apply this minimal doc tweak:
**Configuration:** -- **Issuer URL**: `https://authentik.example.com/application/o/<application_slug>/` +- **Issuer URL**: `https://authentik.example.com/application/o/<application_slug>/` (replace `<application_slug>` with your Authentik application's slug and keep the trailing slash)Or, if you prefer to add a separate line right after the list item:
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback` + +Note: Replace `<application_slug>` with the slug shown in Authentik under Applications → Your Application → “Slug”. Be sure to keep the trailing slash in the URL.
400-400: Placeholder style consistency with the rest of the doc.Elsewhere you use UPPER_SNAKE_CASE placeholders without angle brackets (e.g., YOUR_TENANT_ID, YOUR_REALM, YOUR_UNRAID_IP). For consistency, consider
YOUR_APPLICATION_SLUGhere.Apply this tiny change if you want consistent placeholder styling:
-**Issuer URL**: `https://authentik.example.com/application/o/<application_slug>/` +**Issuer URL**: `https://authentik.example.com/application/o/YOUR_APPLICATION_SLUG/`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
api/docs/public/oidc-provider-setup.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
api/docs/public/oidc-provider-setup.md
[grammar] ~400-~400: There might be a mistake here.
Context: ... Configuration: - Issuer URL: https://authentik.example.com/application/o/<application_slug>/ - Client ID: From Authentik provider con...
(QB_NEW_EN)
🔇 Additional comments (1)
api/docs/public/oidc-provider-setup.md (1)
400-400: Good improvement: placeholder clarifies per-app issuer path for Authentik.Replacing the hard-coded slug with a placeholder reduces misconfiguration risk and matches Authentik’s per-application issuer pattern.
|
legend. |
Change hard coded application slug to <application_slug> to show this needs to be changed to match others (IE https://integrations.goauthentik.io/infrastructure/semaphore/)
Summary by CodeRabbit