Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@smdion
Copy link
Contributor

@smdion smdion commented Aug 18, 2025

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

  • Documentation
    • Updated OIDC provider setup guide: Authentik configuration now shows a placeholder Issuer URL with a dynamic application slug instead of a fixed path. Clarifies how to configure per-application Issuer URLs and reduces setup confusion. No functional changes; guidance only.

Change hard coded application slug to <application_slug> to show this needs to be changed.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 18, 2025

Walkthrough

Documentation 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

Cohort / File(s) Summary of Changes
Docs: OIDC Provider Setup
api/docs/public/oidc-provider-setup.md
Updated Authentik Issuer URL example to use <application_slug> placeholder instead of a fixed unraid-api path; no other content or logic affected.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my ears at docs so neat,
A slug now dances, dynamic and sweet.
No code to chase, no bugs to fight—
Just clearer paths in morning light.
Hop-hop hooray, the guide’s on track,
With placeholders leading the perfect stack. 🐇✨

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
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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_SLUG here.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 541b0ed and a513028.

📒 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.

@smdion smdion changed the title Update oidc-provider-setup.md Authentik SSO Instruction Clarity Aug 18, 2025
@elibosley elibosley merged commit effdbcf into unraid:main Aug 18, 2025
1 check passed
@elibosley
Copy link
Member

legend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants