zero-to-jupyterhub-k8s icon indicating copy to clipboard operation
zero-to-jupyterhub-k8s copied to clipboard

Add Gitlab to authentication docs

Open RaananHadar opened this issue 3 years ago • 1 comments
trafficstars

Proposed change

Gitlab is a relatively common provider for oauth2. I think its a common enough provider to include it in the docs. Currently, the authentication and authorization does not contain instructions how to set it up and i've found the scenario of setting it up either via the generic oauth provider and the GitLabOAuthenticator to be troublesome.

Who would use this feature?

Many users use it as part of their day to day development workflow and it also offers on-prem oauth capabilities compared to public sites, making it attractive for such use cases.

(Optional): Suggest a solution

Creating such docs, with instructions on how to setup a private gitlab host instance would be very beneficial. If you can provide a draft of a working configuration here in the meanwhile it will also be very helpful.

RaananHadar avatar May 04 '22 08:05 RaananHadar

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively. welcome You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

welcome[bot] avatar May 04 '22 08:05 welcome[bot]

While this Helm chart has examples on how to configure authentication for various providers via jupyterhub/oauthenticator, it has been shown to be unsustainable to maintain the same kind of documentation in both places. Due to that, I think we must opt to not provide examples on how to configure GitLab in this Helm chart, but provide a good general example on how to make use of any authenticator in juptyterhub/oauthenticator.

consideRatio avatar Nov 14 '22 10:11 consideRatio

I agree, especially since pass-through configuration means any docs would initially duplicate (and inevitably later lag behind) the existing OAuthenticator docs

manics avatar Mar 12 '23 13:03 manics