Add howto doc on dummy authenticator

This commit is contained in:
yuvipanda
2018-07-27 22:22:45 -07:00
parent 70785f9fd3
commit 95a0359d32
2 changed files with 51 additions and 0 deletions

43
docs/howto/auth/dummy.rst Normal file
View File

@@ -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

View File

@@ -57,6 +57,14 @@ How-To guides answer the question 'How do I...?' for a lot of topics.
howto/notebook-interfaces howto/notebook-interfaces
howto/resource-estimation 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 Topic Guides
============ ============