hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-13 04:53:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2161 from yuvipanda/better-contrib

Browse Source 
Add notes on simplespawner & dummyauthenticator
This commit is contained in:
Min RK
2018-09-21 10:10:04 +02:00
committed by GitHub
parent c975f7eb4a ac82f0f437
commit c69adfb506
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@@ -108,6 +108,29 @@ to make that happen.
Happy developing! Happy developing!
### Using DummyAuthenticator & SimpleSpawner
To simplify testing of JupyterHub,
it's helpful to use DummyAuthenticator instead of the default JupyterHub authenticator
and SimpleSpawner instead of the default spawner.
The default JupyterHub [authenticator](https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html#the-default-pam-authenticator)
& [spawner](https://jupyterhub.readthedocs.io/en/stable/api/spawner.html#localprocessspawner)
require your system to have user accounts for each user you want to log in to
JupyterHub as.
[DummyAuthenticator](https://github.com/jupyterhub/dummyauthenticator) allows
you to log in with any username & password, while
[SimpleSpawner](https://github.com/jupyterhub/simplespawner) allows you to start
servers without having to create a unix user for each JupyterHub user.
Together, these make it much easier to test JupyterHub.
Tip: If you are working on parts of JupyterHub that are common to all
authenticators & spawners, we recommend using both DummyAuthenticator &
SimpleSpawner. If you are working on just authenticator related parts, use
only SimpleSpawner. Similarly, if you are working on just spawner
related parts, use only DummyAuthenticator.
## Troubleshooting a development install ## Troubleshooting a development install
### `lessc` not found ### `lessc` not found