From 99641f94e64ec89edfbf600e25224d11c30a5ad9 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 25 Oct 2016 08:22:24 -0700 Subject: [PATCH] Polish the README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 25ab382..de733b1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ # JupyterHub First Use Authenticator # -A JupyterHub Authenticator that lets users set their password when they first login. +A [JupyterHub](https://jupyterhub.readthedocs.io) authenticator that helps new users set their password on their first login to JupyterHub. -Very useful for transient JupyterHubs being used from a single physical location (such as a workshop), where multiple users need to log in but do not have a pre-existing authentication setup. With this, they can just pick a username and password and go! +**Are you running a workshop from a single physical location, such as a university seminar or a user group?** + +JupyterHub First Use Authenticator can simplify the user set up for you. It's very useful when using transient +JupyterHub instances in a single physical location. It allows multiple users to log in, but you do not have install a pre-existing authentication setup. With this authenticator, users can just pick a username and password and get to work! ## Installation ## @@ -12,7 +15,7 @@ You can install this authenticator with: pip install jupyterhub-firstuseauthenticator ``` -Once installed, you can have JupyterHub use it by adding the following to your `jupyterhub_config.py` file: +Once installed, configure JupyterHub to use it by adding the following to your `jupyterhub_config.py` file: ```python c.JupyterHub.authenticator_class = 'firstuseauthenticator.FirstUseAuthenticator' @@ -20,10 +23,10 @@ c.JupyterHub.authenticator_class = 'firstuseauthenticator.FirstUseAuthenticator' ## Configuration ## -It works out of the box as advertized. There is one configuration parameter you can tweak. +It works out of the box as advertised. There is one configuration parameter, `dbm_path`, which you can tweak. ### FirstUseAuthenticator.dbm_path ### -Path to the [dbm](https://docs.python.org/3.1/library/dbm.html) file used to store usernames and passwords. Put this somewhere where regular users do not have read/write access to it. +Path to the [dbm](https://docs.python.org/3.5/library/dbm.html) file, or a UNIX database file such as `passwords.dbm`, used to store usernames and passwords. The dbm file should be put where regular users do not have read/write access to it. -Defaults to `passwords.dbm` in the current directory from which JupyterHub is spawned. +This authenticator's default setting for the path to the `passwords.dbm` is the current directory from which JupyterHub is spawned.