From 92205d799054da904e9d7f288c4a14cfd0bf8b8f Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Thu, 2 Aug 2018 12:25:57 -0700 Subject: [PATCH] Remove LDAP specific auth howto document This needs a lot more work before it is useful, so we remove it for now. --- docs/howto/auth/ldap.rst | 46 ---------------------------------------- docs/index.rst | 1 - 2 files changed, 47 deletions(-) delete mode 100644 docs/howto/auth/ldap.rst diff --git a/docs/howto/auth/ldap.rst b/docs/howto/auth/ldap.rst deleted file mode 100644 index cece4ff..0000000 --- a/docs/howto/auth/ldap.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _howto/auth/ldap: - -============================= -Using LDAP for authentication -============================= - -`LDAP `_ -is an open and widely-used protocol for authentication. - -The `LDAPAuthenticator's documentation `_ -lists the various configuration options you can set for LDAPAuthenticator. You can set them -in TLJH with the following pattern: - -.. code-block:: bash - - sudo -E tljh-config set auth.. - -When the documentation asks you to set ``LDAPAuthenticator.server_address`` to some -value, you can do that with the following command: - -.. code-block:: bash - - sudo -E tljh-config set auth.LDAPAuthenticator.server_address = 'my-ldap-server' - -Enabling the authenticator -========================== - -For LDAPAuthenticator, the fully qualified name is ``ldapauthenticator.LDAPAuthenticator``. -This is the same name that the `documentation asks `_ -you to set ``c.JupyterHub.authenticator_class`` to. - -For LDAPAuthenticator, this would be: - -.. code-block:: bash - - sudo -E tljh-config set auth.type ldapauthenticator.LDAPAuthenticator - -Once enabled, you need to reload JupyterHub for the config to take effect. - -.. code-block:: bash - - sudo -E tljh-config reload - -Try logging in a separate incognito window to check if your configuration works. This -lets you preserve your terminal in case there were errors. If there are -errors, :ref:`troubleshooting/logs` should help you debug them. diff --git a/docs/index.rst b/docs/index.rst index e5947a7..9ddfc53 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -72,7 +72,6 @@ with your JupyterHub. For more information on Authentication, see :titlesonly: howto/auth/dummy - howto/auth/ldap Topic Guides ============