Files
mshd 3666e438a3 refactor(providers): convert GitHub provider to TypeScript (#4908)
* rewrite github provider in typescript

* rename md js endings

* Update packages/next-auth/src/providers/github.ts

Co-authored-by: Balázs Orbán <info@balazsorban.com>

* add eslint disable next line

Co-authored-by: Balázs Orbán <info@balazsorban.com>
2022-07-13 14:07:24 +02:00

43 lines
785 B
Markdown

---
id: github
title: GitHub
---
## Documentation
https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
## Configuration
https://github.com/settings/apps
## Options
The **Github Provider** comes with a set of default options:
- [Github Provider options](https://github.com/nextauthjs/next-auth/blob/main/src/providers/github.ts)
You can override any of the options to suit your own use case.
## Example
```js
import Providers from `next-auth/providers`
...
providers: [
Providers.GitHub({
clientId: process.env.GITHUB_CLIENT_ID,
clientSecret: process.env.GITHUB_CLIENT_SECRET
})
]
...
```
:::warning
Only allows one callback URL per Client ID / Client Secret.
:::
:::tip
Email address is not returned if privacy settings are enabled.
:::