From 95a0359d32d8eccd6e03c7ecd44fd1ea661e7e27 Mon Sep 17 00:00:00 2001
From: yuvipanda <yuvipanda@gmail.com>
Date: Fri, 27 Jul 2018 22:22:45 -0700
Subject: [PATCH] Add howto doc on dummy authenticator

---
 docs/howto/auth/dummy.rst | 43 +++++++++++++++++++++++++++++++++++++++
 docs/index.rst            |  8 ++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 docs/howto/auth/dummy.rst

diff --git a/docs/howto/auth/dummy.rst b/docs/howto/auth/dummy.rst
new file mode 100644
index 0000000..dc62893
--- /dev/null
+++ b/docs/howto/auth/dummy.rst
@@ -0,0 +1,43 @@
+.. _howto/auth/dummy:
+
+=====================================================
+Authenticate *any* user with a single shared password
+=====================================================
+
+The **Dummy Authenticator** lets *any* user log in with the given password.
+This authenticator is **extremely insecure**, so do not use it if you can
+avoid it.
+
+Enabling the authenticator
+==========================
+
+1. Always use DummyAuthenticator with a password. You can communicate this 
+   password to all your users via an out of band mechanism (like writing on
+   a whiteboard). Once you have selected a password, configure TLJH to use
+   the password by executing the following from an admin console.
+
+.. code-block:: bash
+   
+   tljh-config set auth.DummyAuthenticator.password <password>
+
+   Remember to replace ``<password>`` with the password you choose.
+
+2. Enable the authenticator and reload config to apply configuration:
+
+   tljh-config set auth.type dummyauthenticator.DummyAuthenticator
+   tljh-config reload
+
+Users who are currently logged in will continue to be logged in. When they 
+log out and try to log back in, they will be asked to provide a username and
+password.
+
+Changing the password
+=====================
+
+The password used by DummyAuthenticator can be changed with the following
+commands:
+
+.. code-block:: bash
+
+   tljh-config set auth.DummyAuthenticator.password <new-password>
+   tljh-config reload
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index b3ad167..6fdf76c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -57,6 +57,14 @@ How-To guides answer the question 'How do I...?' for a lot of topics.
    howto/notebook-interfaces
    howto/resource-estimation
 
+We have a special set of How-To Guides on using various forms of authentication
+with your JupyterHub.
+
+.. toctree::
+   :titlesonly:
+
+   howto/auth/dummy
+
 Topic Guides
 ============