https://github.com/izihawa/remote_user_authenticator
https://github.com/izihawa/remote_user_authenticator
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/izihawa/remote_user_authenticator
- Owner: izihawa
- License: apache-2.0
- Created: 2020-01-18T19:12:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-18T19:41:39.000Z (over 5 years ago)
- Last Synced: 2025-02-18T18:52:57.255Z (8 months ago)
- Language: Python
- Size: 5.86 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remote User Authenticator
Authenticate to Jupyterhub using header REMOTE_USER
## Installation
This package can be installed with pip:
```
pip install jupyterhub-remote-user-authenticator-v2
```
## Configuration
You should edit your :file:`jupyterhub_config.py` to set the authenticator class, the RemoteUserLocalAuthenticator provides features such as local user creation. If you already have local users then you may use the RemoteUserAuthenticator authenticator class:
##### For authentication and local user creation
```
c.JupyterHub.authenticator_class = 'remote_user_authenticator.RemoteUserLocalAuthenticator'
```
This class is derived from LocalAuthenticator and therefore provides features such as the ability to add local accounts through the admin interface if configured to do so.
##### For authentication of the token only
```
c.JupyterHub.authenticator_class = 'remote_user_authenticator.RemoteUserAuthenticator'
```
##### Required configuration
```
# Header with username
c.RemoteUserAuthenticator.header_name = 'REMOTE_USER'
```
You should be able to start jupyterhub. :)
## Issues
If you have any issues or bug reports, all are welcome in the issues section. I'll do my best to respond quickly.
## Contribution
If you want to fix the bugs yourself then raise a PR and I'll take a look :)