summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmil Lundberg <emil@emlun.se>2023-11-05 22:51:46 +0100
committerGitHub <noreply@github.com>2023-11-05 22:51:46 +0100
commit3c64de1b4598f5ac70e726bdcf593939c0ea21c0 (patch)
treeefe162f47693e773413387b012826ce8b1891554
parentdfbdd5fb1769faa99fc6e99797237bc17b94b7e7 (diff)
downloadsyncthing-docs-3c64de1b4598f5ac70e726bdcf593939c0ea21c0.zip
Add docs for advanced setting gui.sendBasicAuthPrompt (#783)
Companion PR of syncthing/syncthing#8757
-rw-r--r--users/config.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/users/config.rst b/users/config.rst
index 7d2c2ae..1bb97eb 100644
--- a/users/config.rst
+++ b/users/config.rst
@@ -905,6 +905,25 @@ The following child elements may be present:
``ldap``
LDAP authentication. Requires ldap top level config section to be present.
+.. option:: gui.sendBasicAuthPrompt
+
+ .. versionadded:: 1.26.0
+
+ Prior to version 1.26.0 the GUI used HTTP Basic Authorization for login, but
+ starting in version 1.26.0 it uses an HTML form by default. Basic
+ Authorization is still supported when the ``Authorization`` request header
+ is present in a request, but some browsers don't send the header unless
+ prompted by a 401 response.
+
+ When this setting is enabled, the GUI will respond to unauthenticated
+ requests with a 401 response prompting for Basic Authorization, so that
+ ``https://user:pass@localhost`` style URLs continue to work in standard
+ browsers. Other clients that always send the ``Authorization`` request
+ header do not need this setting.
+
+ When this setting is disabled, the GUI will not send 401 responses so users
+ won't see browser popups prompting for username and password.
+
LDAP Element
------------