使用 GitLab 登录

要为你的项目启用 GitLab 认证，你需要先设置一个 GitLab OAuth 应用，然后把应用的凭证添加到你的 Supabase 控制面板。

🌐 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

为你的应用设置 GitLab 登录包括三个部分：

🌐 Setting up GitLab logins for your application consists of 3 parts:

• 在 GitLab 上创建并配置一个 GitLab 应用
• 将你的 GitLab 应用密钥添加到你的 Supabase 项目
• 将登录代码添加到你的 Supabase JS 客户端应用

登录你的 GitLab 账户 #

🌐 Access your GitLab account

• 去 gitlab.com 。
• 点击右上角的 Login 登录。

找到你的回调网址 #

🌐 Find your callback URL

下一步需要一个回调 URL，看起来像这样：https://<project-ref>.supabase.co/auth/v1/callback

• 前往你的 Supabase 项目仪表板
• 点击左侧边栏的 Authentication 图标
• 在配置部分点击Sign In / Providers
• 点击手风琴列表中的 GitLab 展开，你就会找到你的 回调 URL，你可以点击 Copy 将其复制到剪贴板

本地开发 #

🌐 Local development

在本地使用 Supabase CLI 测试 OAuth 时，确保你的 OAuth 提供商已配置本地 Supabase Auth 回调 URL：

🌐 When testing OAuth locally with the Supabase CLI, ensure your OAuth provider is configured with the local Supabase Auth callback URL:

http://localhost:54321/auth/v1/callback

如果这个回调 URL 缺失或配置错误，OAuth 登录可能会失败，或者在本地开发时无法正确跳转。

🌐 If this callback URL is missing or misconfigured, OAuth sign-in may fail or not redirect correctly during local development.

有关更多详情，请查看本地开发文档。

🌐 See the local development docs for more details.

要在本地使用 Supabase CLI 测试 OAuth，请参阅本地开发文档。

🌐 For testing OAuth locally with the Supabase CLI see the local development docs.

创建你的 GitLab 应用 #

🌐 Create your GitLab application

• 点击右上角的你的 profile logo（头像）。
• 选择 Edit profile。
• 在左边的侧边栏中，选择应用。
• 输入应用的名称。
• 在 Redirect URI 框中，输入你应用的回调 URL。
• 勾选 Confidential 旁边的框（确保它已被勾选）。
• 检查名为 read_user 的范围（这是唯一必需的范围）。
• 点击底部的 Save Application。
• 复制并保存你的 Application ID (client_id) 和 Secret (client_secret)，你稍后会用到。

把你的 GitLab 凭证添加到你的 Supabase 项目里 #

🌐 Add your GitLab credentials into your Supabase project

• 前往你的 Supabase 项目仪表板
• 在左侧边栏，点击Authentication图标（靠近顶部）
• 在配置部分点击Providers
• 从手风琴列表中点击 GitLab 来展开，然后将 GitLab 启用 切换为开启
• 输入你在上一步保存的 GitLab 客户端 ID 和 GitLab 客户端密钥
• 点击 Save

在你的客户端应用中添加登录代码 #

🌐 Add login code to your client app

1
import { createClient } from '@supabase/supabase-js'
2
3
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
4
5
// ---cut---
6
async function signInWithGitLab() {
7
  const { data, error } = await supabase.auth.signInWithOAuth({
8
    provider: 'gitlab',
9
  })
10
}

以 PKCE 流程为例，比如在服务端认证中，你需要一个额外的步骤来处理代码交换。在调用 signInWithOAuth 时，提供一个指向回调路由的 redirectTo URL。这个重定向 URL 应该添加到你的 重定向允许列表 中。

🌐 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.

1
import { createClient, type Provider } from '@supabase/supabase-js';
2
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
3
const provider = 'provider' as Provider
4
5
// ---cut---
6
await supabase.auth.signInWithOAuth({
7
  provider,
8
  options: {
9
    redirectTo: `http://example.com/auth/callback`,
10
  },
11
})

在回调端点，处理代码交换以保存用户会话。

🌐 At the callback endpoint, handle the code exchange to save the user session.

1
import { NextResponse } from 'next/server'
2
3
// The client you created from the Server-Side Auth instructions
4
import { createClient } from '@/utils/supabase/server'
5
6
export async function GET(request: Request) {
7
  const { searchParams, origin } = new URL(request.url)
8
  const code = searchParams.get('code')
9
  // if "next" is in param, use it as the redirect URL
10
  let next = searchParams.get('next') ?? '/'
11
  if (!next.startsWith('/')) {
12
    // if "next" is not a relative URL, use the default
13
    next = '/'
14
  }
15
16
  if (code) {
17
    const supabase = await createClient()
18
    const { error } = await supabase.auth.exchangeCodeForSession(code)
19
    if (!error) {
20
      const forwardedHost = request.headers.get('x-forwarded-host') // original origin before load balancer
21
      const isLocalEnv = process.env.NODE_ENV === 'development'
22
      if (isLocalEnv) {
23
        // we can be sure that there is no load balancer in between, so no need to watch for X-Forwarded-Host
24
        return NextResponse.redirect(`${origin}${next}`)
25
      } else if (forwardedHost) {
26
        return NextResponse.redirect(`https://${forwardedHost}${next}`)
27
      } else {
28
        return NextResponse.redirect(`${origin}${next}`)
29
      }
30
    }
31
  }
32
33
  // return the user to an error page with instructions
34
  return NextResponse.redirect(`${origin}/auth/auth-code-error`)
35
}

1
import { createClient } from '@supabase/supabase-js'
2
3
const supabase = createClient('https://your-project-id.supabase.co', 'sb_publishable_...')
4
5
// ---cut---
6
async function signOut() {
7
  const { error } = await supabase.auth.signOut()
8
}

资源 #

🌐 Resources

• Supabase - 免费开始
• Supabase JS 客户端
• GitLab 账户