mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
6a58bb03b0
<!-- ELLIPSIS_HIDDEN -->
> [!IMPORTANT]
> Add Twitch as a new OAuth provider, updating backend logic and UI
components to support Twitch authentication.
>
> - **Behavior**:
> - Add `TwitchProvider` class in `providers/twitch.tsx` to handle OAuth
with Twitch, including user info post-processing.
> - Update `_providers` in `index.tsx` to include `TwitchProvider`.
> - Add `TWITCH` to `StandardOAuthProviderType` enum in `schema.prisma`.
> - **UI Components**:
> - Add Twitch icon and color in `brand-icons.tsx` and `BRAND_COLORS`.
> - Update `ProviderIcon`, `ProviderSettingDialog`, and `OAuthButton` to
support Twitch in `providers.tsx` and `oauth-button.tsx`.
> - **Misc**:
> - Add `twitch` to `standardProviders` in `oauth.tsx`.
>
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup>
for 08c0de5762. You can
[customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this
summary. It will automatically update as commits are pushed.</sup>
<!-- ELLIPSIS_HIDDEN -->
---------
Co-authored-by: Zai Shi <zaishi00@outlook.com>
39 lines
1.5 KiB
Plaintext
39 lines
1.5 KiB
Plaintext
---
|
|
title: "GitHub"
|
|
---
|
|
|
|
This guide explains how to set up GitHub as an authentication provider with Stack Auth. GitHub OAuth allows users to sign in to your application using their GitHub account.
|
|
|
|
<Info>
|
|
For Development purposes, Stack Auth uses shared keys for this provider. Shared keys are automatically created by Stack, but show Stack's logo on the OAuth sign-in page.
|
|
You should replace these before you go into production.
|
|
</Info>
|
|
|
|
## Integration Steps
|
|
|
|
<Steps>
|
|
<Step>
|
|
### Create a GitHub OAuth App
|
|
|
|
1. Navigate to your [GitHub Developer Settings](https://github.com/settings/developers).
|
|
2. Click the **New OAuth App** button.
|
|
3. Enter a name for your application, homepage URL, and a description.
|
|
4. For **Authorization callback URL**, add `https://api.stack-auth.com/api/v1/auth/oauth/callback/github`
|
|
5. Click **Register application**
|
|
6. Save the **Client ID** and click **Generate a new client secret** to create your **Client Secret**.
|
|
</Step>
|
|
|
|
<Step>
|
|
### Enable GitHub OAuth in Stack Auth
|
|
|
|
1. On the Stack Auth dashboard, select **Auth Methods** in the left sidebar.
|
|
2. Click **Add SSO Providers** and select **GitHub** as the provider.
|
|
3. Set the **Client ID** and **Client Secret** you obtained from GitHub earlier.
|
|
</Step>
|
|
</Steps>
|
|
|
|
### Need More Help?
|
|
|
|
- Check the [GitHub OAuth Documentation](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps)
|
|
- Join our [Discord](https://discord.stack-auth.com)
|