Skip to content

docs: add self-hosted GitLab OAuth setup guide#5702

Merged
H2Shami merged 15 commits intomainfrom
admin-mcp/gitlab-self-hosted-docs-a5c82a9
May 8, 2026
Merged

docs: add self-hosted GitLab OAuth setup guide#5702
H2Shami merged 15 commits intomainfrom
admin-mcp/gitlab-self-hosted-docs-a5c82a9

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 7, 2026

Summary

Adds a new docs page at /deploy/gitlab-self-hosted walking customers through connecting a self-hosted GitLab instance to Mintlify via OAuth (the OAuth flow used by workflows — distinct from the existing deploy-token integration).

What it covers

  • Prerequisites — admin access on the GitLab instance, public reachability from dashboard.mintlify.com, feature-flag enrollment.
  • Set up the connection — registering the OAuth application on GitLab (with the right Redirect URI, scopes, Confidential/Trusted settings), copying credentials into Mintlify, authorizing, and selecting projects to enable webhooks on.
  • Rotate credentials — when the GitLab-side secret rotates (which it does silently on edit), the delete-and-re-add flow.
  • Troubleshooting — the four most common failure modes from real testing:
    • invalid_client after authorize (stale secret)
    • Webhook registration Invalid url given (GitLab outbound-request allowlist)
    • Missing consent screen (Trusted flag or pre-existing user grant)
    • Local dev URL mismatches (host.docker.internal)

Why now

This page is referenced from the dashboard's Settings → Git settings → GitLab OAuth → Self-hosted GitLab card via a "How to create the OAuth app" link. Companion to mintlify/server#5100 and mintlify/mint#7564, which add the underlying OAuth flow.

Heads-up

The link in the dashboard component currently points at https://mintlify.com/docs/settings/gitlab-self-hosted, but the docs site has no /settings/ namespace. The page lives at /deploy/gitlab-self-hosted (sibling to the existing GitLab guide). The dashboard PR needs a one-line update to match the new path.

Test plan

  • Open the page in the docs preview and verify Steps render, Frame screenshots aren't broken (none are referenced — text-only initially), and internal anchor [Rotate credentials](#rotate-credentials) resolves.
  • Spot-check that the new page appears in the left nav under the same group as /deploy/gitlab.
  • Cross-check the URLs and admin paths against a real self-hosted GitLab instance once available.

Mintlify

0 threads from 0 users in Mintlify

  • No unresolved comments

Open in Mintlify Editor


Note

Low Risk
Low risk: documentation-only changes plus a nav entry; no runtime code or behavior is modified.

Overview
Adds a new /deploy/gitlab-self-hosted doc that explains how to connect a self-hosted GitLab instance to Mintlify via OAuth for workflows (app registration, required scopes/redirect URI, authorization, and project webhook selection), with credential-rotation and troubleshooting guidance.

Updates docs.json navigation to include the new page under Deploy alongside the existing deploy/gitlab guide.

Reviewed by Cursor Bugbot for commit 1f62f6f. Bugbot is set up for automated code reviews on this repo. Configure here.

Mintlify-Source: dashboard-editor
@mintlify-development
Copy link
Copy Markdown
Contributor

mintlify-development Bot commented May 7, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🟢 Ready View Preview May 7, 2026, 11:02 PM

Mintlify-Source: dashboard-editor
Mintlify-Source: dashboard-editor
@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 7, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 7, 2026, 11:05 PM

Mintlify-Source: dashboard-editor
Copy link
Copy Markdown
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just some style edits but lgtm!

Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
Comment thread deploy/gitlab-self-hosted.mdx Outdated
H2Shami and others added 4 commits May 7, 2026 16:55
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
H2Shami and others added 2 commits May 7, 2026 16:56
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
H2Shami and others added 2 commits May 7, 2026 16:58
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@H2Shami H2Shami merged commit 9e8e222 into main May 8, 2026
6 checks passed
@H2Shami H2Shami deleted the admin-mcp/gitlab-self-hosted-docs-a5c82a9 branch May 8, 2026 17:20
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.

3 participants