Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on Custom Providers #10799

Closed
ebratz opened this issue May 2, 2024 · 4 comments
Closed

Documentation on Custom Providers #10799

ebratz opened this issue May 2, 2024 · 4 comments
Labels
documentation Relates to documentation triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime.

Comments

@ebratz
Copy link

ebratz commented May 2, 2024

What is the improvement or update you wish to see?

Would be great to have a good documentation explainin on how to create a custom authentication provider, as we had on previous versions

Is there any context that might help us understand?

On previous versions, we had the possibility to extend the providers creating custom providers. One example would be to have an Email Provider supporting Amazon SES as email service.

Does the docs page already exist? Please link to it.

No response

@ebratz ebratz added documentation Relates to documentation triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime. labels May 2, 2024
@ndom91
Copy link
Member

ndom91 commented May 6, 2024

Yeah that makes sense. We have the following general "extend the providers" / "use your own provider" guide: https://authjs.dev/guides/configuring-oauth-providers#use-your-own-provider

And for email specifically: https://authjs.dev/guides/configuring-http-email

Do those cover what you're looking for?

@ebratz
Copy link
Author

ebratz commented May 6, 2024

That could help for advanced users, but the documentations should be more user friendly for intermediate users as well. The type definitions are not clear on the examples, you need to dig into the core code to understand how other providers were implemented. After spending a lot of time I could understand and implement it, but felt I spent way more time that should be needed for such task. I understand this is temporary since things are moving faster for v5 but documentations is a very important topic for tech adoption

@ndom91
Copy link
Member

ndom91 commented May 12, 2024

Yeah I can definitely appreciate that. What would you recommend for making those two examples I provided above, for example, more beginner / intermediate friendly?

@ndom91
Copy link
Member

ndom91 commented May 17, 2024

Going to close this issue, feel free to open a PR with any improvements you may see and we can talk about it more there 🙏

@ndom91 ndom91 closed this as completed May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation triage Unseen or unconfirmed by a maintainer yet. Provide extra information in the meantime.
Projects
None yet
Development

No branches or pull requests

2 participants