From 0a54b1aa9971bf0bc3a7a84f059e1b65310ad3c4 Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Thu, 20 Sep 2018 13:01:49 -0700 Subject: [PATCH 1/3] Add notes on simplespawner & dummyauthenticator --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0fdd5ee..bcf6ec52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,6 +108,26 @@ to make that happen. Happy developing! +### Using DummyAuthenticator & SimpleSpawner + +The default JupyterHub authenticator & spawner require your +system to have user accounts for each user you want to log in to +JupyterHub as. This requires you have root / `sudo` access to your +machine. It also gets cumbersome & insecure quickly as you +do development. + +[DummyAuthenticator](https://github.com/jupyterhub/dummyauthenticator) allows +you to log in with any username & password. +[SimpleSpawner](https://github.com/jupyterhub/simplespawner) lets you start +servers without having to create unix users for each JupyterHub user. +Together, these make it much easier to test JupyterHub. + +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 ### `lessc` not found From 0b98be05fddea2a3ddb35123aaad81ad9de51757 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Thu, 20 Sep 2018 22:06:11 +0000 Subject: [PATCH 2/3] Add links to default spawner & authenticator --- CONTRIBUTING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcf6ec52..a57b785b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -110,11 +110,10 @@ Happy developing! ### Using DummyAuthenticator & SimpleSpawner -The default JupyterHub authenticator & spawner require your -system to have user accounts for each user you want to log in to -JupyterHub as. This requires you have root / `sudo` access to your -machine. It also gets cumbersome & insecure quickly as you -do development. +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. From ac82f0f4376dc3cb20d564e930e9a434059ff4d8 Mon Sep 17 00:00:00 2001 From: Min RK Date: Fri, 21 Sep 2018 10:07:21 +0200 Subject: [PATCH 3/3] apply willingc's text proposals --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a57b785b..544513c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -110,18 +110,22 @@ 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. -[SimpleSpawner](https://github.com/jupyterhub/simplespawner) lets you start -servers without having to create unix users for each JupyterHub user. +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. -If you are working on parts of JupyterHub that are common to all +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