From 10f262a2fb609f6c5f1f14f68bcdbaa0d16de684 Mon Sep 17 00:00:00 2001
From: Konstantin Taletskiy <konstantin@taletskiy.com>
Date: Wed, 9 Apr 2025 20:52:37 -0700
Subject: [PATCH] Add Temporary Authenticator documentation

---
 docs/howto/auth/tmpauth.md | 63 ++++++++++++++++++++++++++++++++++++++
 docs/howto/index.md        |  1 +
 2 files changed, 64 insertions(+)
 create mode 100644 docs/howto/auth/tmpauth.md

diff --git a/docs/howto/auth/tmpauth.md b/docs/howto/auth/tmpauth.md
new file mode 100644
index 00000000..6e04c31f
--- /dev/null
+++ b/docs/howto/auth/tmpauth.md
@@ -0,0 +1,63 @@
+(howto-auth-dummy)=
+
+# Authenticate users with temporary accounts automatically
+
+```{warning}
+The **Temporary Authenticator** lets _any_ user access JupyterHub without logging in.
+This authenticator is designed for open deployments and should be used with caution
+in environments where access control is important.
+```
+
+## Enabling the authenticator
+
+1. Install the TmpAuthenticator package:
+
+   ```bash
+   sudo pip3 install jupyterhub-tmpauthenticator
+   ```
+
+2. Enable the authenticator and configure it to allow all users:
+
+   ```bash
+   sudo tljh-config set auth.type tmpauthenticator.TmpAuthenticator
+   sudo tljh-config set auth.TmpAuthenticator.allow_all 'True'
+   ```
+
+3. Reload the configuration to apply changes:
+
+   ```bash
+   sudo tljh-config reload
+   ```
+
+## How it works
+
+The Temporary Authenticator:
+- Gives anyone who visits the JupyterHub landing page a user account without requiring login
+- Automatically spawns a single-user server for each visitor
+- Redirects users directly to their server without requiring them to click additional buttons
+
+This is particularly useful for temporary deployments, workshops, or demonstration environments where ease of access is more important than user authentication.
+
+## Configuration options
+
+While the default configuration works for most temporary deployments, you can customize the behavior:
+
+### Disabling automatic login
+
+By default, TmpAuthenticator automatically logs users in. You can change this behavior:
+
+```bash
+sudo tljh-config set auth.TmpAuthenticator.auto_login 'False'
+sudo tljh-config reload
+```
+
+With `auto_login` set to `False`, users will see a home page with a "Sign in" button.
+
+### Customizing the login button text
+
+If you've disabled automatic login, you can customize the text shown on the login button:
+
+```bash
+sudo tljh-config set auth.TmpAuthenticator.login_service 'Temporary Access'
+sudo tljh-config reload
+```
diff --git a/docs/howto/index.md b/docs/howto/index.md
index 7b288855..8777be08 100644
--- a/docs/howto/index.md
+++ b/docs/howto/index.md
@@ -36,6 +36,7 @@ with your JupyterHub. For more information on Authentication, see
 :titlesonly: true
 
 auth/dummy
+auth/tmpauth
 auth/github
 auth/google
 auth/awscognito