Skip to content

Commit

Permalink
Add docs for advanced setting gui.sendBasicAuthPrompt (#783)
Browse files Browse the repository at this point in the history
Companion PR of syncthing/syncthing#8757
  • Loading branch information
emlun authored Nov 5, 2023
1 parent dfbdd5f commit 3c64de1
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions users/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down

0 comments on commit 3c64de1

Please sign in to comment.