Configuring GitHub Authentication¶
To enable single sign-on (SSO) and streamline user management, you can integrate GitHub—either public GitHub.com or a private GitHub Enterprise instance—as an OAuth provider in the MemVerge AI platform. Follow the steps below to register a GitHub OAuth application and connect it to your cluster.
1. Choose Your GitHub Version¶
- Public GitHub.com
- Use this option if your organization stores code on GitHub’s public service.
- Private GitHub Enterprise
- If you have a self-hosted GitHub Enterprise server, select this option and provide the internal URL when prompted.
Note: The steps for creating an OAuth app are similar, but the form URLs differ slightly between public and enterprise GitHub.
2. Create an OAuth App in GitHub¶
- Open GitHub Settings
- Log in to GitHub and navigate to your Profile → Settings.
- Under Developer Settings, select OAuth Apps (or GitHub Apps if your UI differs).
-
Click “New OAuth App” to begin registration.
-
Fill In App Details
- Application name: Any recognizable name for the MemVerge AI platform integration (e.g., “MemVerge.ai”).
- Homepage URL: Enter the URL of your MemVerge AI deployment (e.g.,
https://demo.memvergelab.com
). - Application description (optional): A brief note indicating the purpose of this app.
-
Authorization callback URL: Must match your platform’s callback address (e.g.,
https://demo.memvergelab.com
). -
Register Application
- Once complete, click Register application. GitHub will generate a Client ID and Client Secret.
3. Configure the MemVerge AI Platform¶
- Open Auth Providers
- In the MemVerge AI UI, select Users & Authentication → Auth Providers.
-
Choose GitHub from the list and ensure you pick the matching option (public or enterprise).
-
Enter OAuth Credentials
- Client ID: Paste the Client ID from the GitHub OAuth App.
-
Client Secret: Paste the Client Secret.
-
Save and Activate
- Click Save at the bottom of the dialog.
- Once saved, you can switch GitHub to Active. MemVerge AI will now accept GitHub-authenticated logins.
4. Testing & Troubleshooting¶
- Login Prompt: After enabling GitHub, navigate to your platform’s login page. You should see a Sign in with GitHub option.
- Enterprise URL: For GitHub Enterprise, verify the internal domain is set correctly in your Auth Provider settings.
- Callback Mismatch: If you encounter errors like “redirect_uri mismatch”, confirm the Authorization callback URL in GitHub matches exactly what is listed in MemVerge AI.
- Certificate and Firewall: For self-hosted GitHub Enterprise, ensure SSL certificates and network rules permit secure connectivity between the MemVerge AI platform and GitHub.
With GitHub OAuth configured, users can seamlessly log in using their GitHub credentials, leveraging existing security measures (e.g., two-factor authentication) and organizational membership. This setup simplifies onboarding and enhances security across your AI workloads.