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 gaps (readme.md), is this framework ONLY for auth0, or can work with any OIDC provider? #613

Closed
6 tasks done
DmitriyAlergant-T1A opened this issue Apr 9, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@DmitriyAlergant-T1A
Copy link

Checklist

Description

The documentation, FAQ, examples and readme.md do not give clarity on a very simple question: is this framework Auth0-specific, or can it be used directly with other OpenID providers (ex: Microsoft, Google)?

The framework name suggests it might be generic; Yet there is zero information on its configuration for other providers (without using Auth0 as a intermediary)...

It's totally fine if it is actually Auth0-specific (this is your product after all), but then this deserves to be mentioned explicitly in the first line of README.MD.

Thanks!

Reproduction

n/a

Additional context

No response

express-openid-connect version

n/a

Express version

n/a

Node.js version

n/a

@DmitriyAlergant-T1A DmitriyAlergant-T1A added the bug Something isn't working label Apr 9, 2024
@frederikprijck
Copy link
Member

This is not Auth0-Specific. But built by Auth0 so that is why the documentation is focussed on Auth0. But you are free to use it with other identity providers, and report issues along the way as the intention is to support them as long as they are OIDC compliant and the fixes are not vendor-specific.

We also refuse to add Auth0 specifics in this SDK to ensure it works with other IDPs that support OIDC, see: #615 (comment)

@DmitriyAlergant-T1A-Rogers
Copy link

DmitriyAlergant-T1A-Rogers commented Apr 19, 2024

Thanks for the comment; However my remark still stands - it would be great if README.md explicitly mentioned the purpose and status of this framework (in similar verbiage as you've put here). It was really confusing until I raised this issue. And the feeling was that it's likely Auth0-exclusive so I have not even tried connecting it directly with Google.

@DmitriyAlergant-T1A-Rogers

The readme now says...

Getting Started
...

1. Configure Auth0

It could have said "Getting started (if you will be using Auth0)" or something like that... You got it...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants