mirror of
https://github.com/LukeHagar/better-auth.git
synced 2025-12-09 20:27:44 +00:00
49 lines
1.9 KiB
Plaintext
49 lines
1.9 KiB
Plaintext
---
|
|
title: Github
|
|
description: Github Provider
|
|
---
|
|
|
|
<Steps>
|
|
<Step>
|
|
### Get your Github credentials
|
|
To use Github sign in, you need a client ID and client secret. You can get them from the [Github Developer Portal](https://github.com/settings/developers).
|
|
|
|
Make sure to set the redirect URL to `http://localhost:3000/api/auth/callback/github` for local development. For production, you should set it to the URL of your application. If you change the base path of the auth routes, you should update the redirect URL accordingly.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Configure the provider
|
|
To configure the provider, you need to import the provider and pass it to the `socialProviders` option of the auth instance.
|
|
|
|
```ts title="auth.ts"
|
|
import { betterAuth } from "better-auth"
|
|
import { github } from "better-auth/social-providers"
|
|
|
|
export const auth = betterAuth({
|
|
socialProviders: { // [!code highlight]
|
|
github: { // [!code highlight]
|
|
clientId: process.env.GITHUB_CLIENT_ID as string, // [!code highlight]
|
|
clientSecret: process.env.GITHUB_CLIENT_SECRET as string, // [!code highlight]
|
|
}, // [!code highlight]
|
|
}, // [!code highlight]
|
|
})
|
|
```
|
|
</Step>
|
|
<Step>
|
|
### Signin with Github
|
|
To signin with Gitjub, you can use the `signIn.social` function provided by the client. The `signIn` function takes an object with the following properties:
|
|
- `provider`: The provider to use. It should be set to `github`.
|
|
|
|
```ts title="client.ts"
|
|
import { createAuthClient } from "better-auth/client"
|
|
const client = createAuthClient()
|
|
|
|
const signin = async () => {
|
|
const data = await client.signIn.social({
|
|
provider: "github"
|
|
})
|
|
}
|
|
```
|
|
</Step>
|
|
</Steps>
|