Login with GitLab
To enable GitLab Auth for your project, you need to set up a GitLab OAuth application and add the application credentials to your Supabase Dashboard.
Overview
Setting up GitLab logins for your application consists of 3 parts:
- Create and configure a GitLab Application on GitLab
- Add your GitLab Application keys to your Supabase Project
- Add the login code to your Supabase JS Client App
Access your GitLab account
- Go to gitlab.com.
- Click on
Login
at the top right to log in.
Find your callback URL
The next step requires a callback URL, which looks like this: https://<project-ref>.supabase.co/auth/v1/callback
- Go to your Supabase Project Dashboard
- Click on the
Authentication
icon in the left sidebar - Click on
Providers
under the Configuration section - Click on GitLab from the accordion list to expand and you'll find your Callback URL, you can click
Copy
to copy it to the clipboard
For testing OAuth locally with the Supabase CLI please see the local development docs.
Create your GitLab application
- Click on your
profile logo
(avatar) in the top-right corner. - Select
Edit profile
. - In the left sidebar, select Applications.
- Enter the name of the application.
- In the
Redirect URI
box, type the callback URL of your app. - Check the box next to
Confidential
(make sure it is checked). - Check the scope named
read_user
(this is the only required scope). - Click
Save Application
at the bottom. - Copy and save your
Application ID
(client_id
) andSecret
(client_secret
) which you'll need later.
Add your GitLab credentials into your Supabase project
- Go to your Supabase Project Dashboard
- In the left sidebar, click the
Authentication
icon (near the top) - Click on
Providers
under the Configuration section - Click on GitLab from the accordion list to expand and turn GitLab Enabled to ON
- Enter your GitLab Client ID and GitLab Client Secret saved in the previous step
- Click
Save
Add login code to your client app
Make sure you're using the right supabase
client in the following code.
If you're not using Server-Side Rendering or cookie-based Auth, you can directly use the createClient
from @supabase/supabase-js
. If you're using Server-Side Rendering, see the Server-Side Auth guide for instructions on creating your Supabase client.
When your user signs in, call signInWithOAuth() with gitlab
as the provider
:
_10async function signInWithGitLab() {_10 const { data, error } = await supabase.auth.signInWithOAuth({_10 provider: 'gitlab',_10 })_10}
For a PKCE flow, for example in Server-Side Auth, you need an extra step to handle the code exchange. When calling signInWithOAuth
, provide a redirectTo
URL which points to a callback route. This redirect URL should be added to your redirect allow list.
In the browser, signInWithOAuth
automatically redirects to the OAuth provider's authentication endpoint, which then redirects to your endpoint.
_10await supabase.auth.signInWithOAuth({_10 provider,_10 options: {_10 redirectTo: `http://example.com/auth/callback`,_10 },_10})
At the callback endpoint, handle the code exchange to save the user session.
Create a new file at app/auth/callback/route.ts
and populate with the following:
When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:
_10async function signOut() {_10 const { error } = await supabase.auth.signOut()_10}