Auth

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:

Access your GitLab account

  • Go to gitlab.com.
  • Click on Login at the top right to log in.

GitLab Developer Portal.

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

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) and Secret (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

When your user signs in, call signInWithOAuth() with gitlab as the provider:


_10
async 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.


_10
await 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:

app/auth/callback/route.ts

_38
import { cookies } from 'next/headers'
_38
import { NextResponse } from 'next/server'
_38
import { type CookieOptions, createServerClient } from '@supabase/ssr'
_38
_38
export async function GET(request: Request) {
_38
const { searchParams, origin } = new URL(request.url)
_38
const code = searchParams.get('code')
_38
// if "next" is in param, use it as the redirect URL
_38
const next = searchParams.get('next') ?? '/'
_38
_38
if (code) {
_38
const cookieStore = cookies()
_38
const supabase = createServerClient(
_38
process.env.NEXT_PUBLIC_SUPABASE_URL!,
_38
process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
_38
{
_38
cookies: {
_38
get(name: string) {
_38
return cookieStore.get(name)?.value
_38
},
_38
set(name: string, value: string, options: CookieOptions) {
_38
cookieStore.set({ name, value, ...options })
_38
},
_38
remove(name: string, options: CookieOptions) {
_38
cookieStore.delete({ name, ...options })
_38
},
_38
},
_38
}
_38
)
_38
const { error } = await supabase.auth.exchangeCodeForSession(code)
_38
if (!error) {
_38
return NextResponse.redirect(`${origin}${next}`)
_38
}
_38
}
_38
_38
// return the user to an error page with instructions
_38
return NextResponse.redirect(`${origin}/auth/auth-code-error`)
_38
}

When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:


_10
async function signOut() {
_10
const { error } = await supabase.auth.signOut()
_10
}

Resources