Docs for our supported OAuth providers #134
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
docs/package.json
Outdated
| @@ -20,11 +20,21 @@ | |||
| }, | |||
| "homepage": "https://github.com/shuding/nextra-docs-template#readme", | |||
| "dependencies": { | |||
| "@hookform/resolvers": "^3.9.1", | |||
There was a problem hiding this comment.
Is this for components we aren't using?
There was a problem hiding this comment.
I think this might be for the use of the shadcn/ui forms component that I tried but backed out - I'll remove it.
| [Apple](oauth/apple) as OAuth providers. You can also try any of the 80 OAuth | ||
| providers bundled with Auth.js (see the list in the sidebar of | ||
| [Auth.js docs](https://authjs.dev/getting-started/providers/github)), but note | ||
| that **we don't provide support for using these other providers**. |
There was a problem hiding this comment.
This clarity is great. If we hear from community members these are working we could link to guides on them.
docs/pages/config/oauth/apple.mdx
Outdated
| Unlike other providers, Apple doesn't allow you to test your **Sign in with | ||
| Apple** integration using an app running on `localhost`. You'll need to fully | ||
| deploy your application to a public site with a valid SSL certificate. | ||
| {/* or setup a DNS |
There was a problem hiding this comment.
TODO for the future or easter egg for folks reading the docs? I like it, like a footnote only for people who read the source, but maybe stick it in parens instead?
There was a problem hiding this comment.
Haha something that I meant to pull out but forgot - I think I pulled it out in a separate commit while you were reviewing.
Unfortunately you can't just map a DNS name to 127.0.0.1 - you also need SSL, and if someone wants that bad enough there are other guides out there for how to do it.
docs/pages/config/oauth/github.mdx
Outdated
| will be presented to users when they attempt to login with GitHub for your | ||
| application. | ||
|
|
||
| For the **Homepage URL**, use `http://localhost:5173`. |
There was a problem hiding this comment.
Is this assuming Vite, should we add "or whatever your application uses," or mention 3000 if you use Next.js?
There was a problem hiding this comment.
Yeah, I guess I was assuming Vite here - but I'll add a note suggesting that users double check their port based on the framework they're using.
| as the last argument to the following command (run in your terminal): | ||
|
|
||
| ``` | ||
| npx convex env set AUTH_GOOGLE_SECRET <yourgooglesecret> |
There was a problem hiding this comment.
add a note that this can also be done in the dashboard somewhere?
Also v minor, but are there discriptive first few characters you could include in these, as a check for what a githubclientid or githubsecret looks like?
There was a problem hiding this comment.
SG, I'll mention something about the dashboard.
Re: characters, I'm not sure there's anything we can depend on. I have a few GH OAuth apps configured and the client IDs all start with Ov23li, but I'm not sure how that's generated. It's quite possible that it's not the case for others or something they'll change the future.
| "lib": "@/lib", | ||
| "hooks": "@/hooks" | ||
| }, | ||
| "iconLibrary": "lucide" |
There was a problem hiding this comment.
it's tempting to avoid this whole shadcn components thing since what we need it so small but nice if we're adding more. We can always remove it later.
There was a problem hiding this comment.
We already use it in the auth example apps, but yeah, the use is pretty minimal. It's used in the example auth apps too.
Mostly some doc updates/clarification.
|
Thanks for the review! |
Includes detailed setup docs for GitHub, Google and Apple.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.