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.

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

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) 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

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

async function signInWithGitLab() {
  const { data, error } = await supabase.auth.signInWithOAuth({
    provider: 'gitlab',
  })
}

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.

await supabase.auth.signInWithOAuth({
  provider,
  options: {
    redirectTo: `http://example.com/auth/callback`,
  },
})

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

import { cookies } from 'next/headers'
import { NextResponse } from 'next/server'
import { type CookieOptions, createServerClient } from '@supabase/ssr'

export async function GET(request: Request) {
  const { searchParams, origin } = new URL(request.url)
  const code = searchParams.get('code')
  // if "next" is in param, use it as the redirect URL
  const next = searchParams.get('next') ?? '/'

  if (code) {
    const cookieStore = cookies()
    const supabase = createServerClient(
      process.env.NEXT_PUBLIC_SUPABASE_URL!,
      process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,
      {
        cookies: {
          get(name: string) {
            return cookieStore.get(name)?.value
          },
          set(name: string, value: string, options: CookieOptions) {
            cookieStore.set({ name, value, ...options })
          },
          remove(name: string, options: CookieOptions) {
            cookieStore.delete({ name, ...options })
          },
        },
      }
    )
    const { error } = await supabase.auth.exchangeCodeForSession(code)
    if (!error) {
      return NextResponse.redirect(`${origin}${next}`)
    }
  }

  // return the user to an error page with instructions
  return NextResponse.redirect(`${origin}/auth/auth-code-error`)
}

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

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

Resources

Edit this page on GitHub

Login with GitLab

Overview#

Access your GitLab account#

Find your callback URL#

Create your GitLab application#

Add your GitLab credentials into your Supabase project#

Add login code to your client app#

Resources#

Is this helpful?