aboutsummaryrefslogtreecommitdiffstats
path: root/docs/features/proxyauth.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/features/proxyauth.rst')
-rw-r--r--docs/features/proxyauth.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/features/proxyauth.rst b/docs/features/proxyauth.rst
new file mode 100644
index 00000000..edc428a7
--- /dev/null
+++ b/docs/features/proxyauth.rst
@@ -0,0 +1,17 @@
+.. _proxyauth:
+
+Proxy Authentication
+====================
+
+
+Asks the user for authentication before they are permitted to use the proxy.
+Authentication headers are stripped from the flows, so they are not passed to
+upstream servers. For now, only HTTP Basic authentication is supported. The
+proxy auth options are not compatible with the transparent, socks or reverse proxy
+mode.
+
+================== =============================
+command-line :option:`--nonanonymous`,
+ :option:`--singleuser USER`,
+ :option:`--htpasswd PATH`
+================== ============================= \ No newline at end of file