Skip to content

Commit 1249b67

Browse files
sunkuprfc2822
andauthored
Document login_credentials_lock setting (#43)
* Document login_credentials_lock setting; deprecate login_lock_credentials * Add version * Enhance message * Use RSt for versionadded/deprecated --------- Co-authored-by: Ricki Hirner <[email protected]>
1 parent a2ca9ef commit 1249b67

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

managed_davx5.rst

+17-4
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ It's advisable to set an expiration time for the configuration file on the Web s
7272
Configuration variables
7373
=======================
7474

75-
These variables can be used for Managed DAVx⁵ configuration:
75+
These variables can be used for Managed DAVx⁵ configuration.
76+
77+
If they are specific to a certain version, this is mentioned before the variable. Deprecated variables shouldn't be used anymore and will be removed in the future. Use their replacements instead.
7678

7779
:Name: license
7880
:Type: text
@@ -136,16 +138,26 @@ These variables can be used for Managed DAVx⁵ configuration:
136138
:Type: text
137139
:Required: no
138140
:Description: pre-filled password when an account is added; see security note below
139-
140141
.. warning::
141142
Using ``login_password`` is only recommended with app-specific per-user passwords. Keep in mind that the user
142-
may be able to retrieve the password even if ``login_lock_credentials`` is set.
143+
may be able to retrieve the password even if ``login_credentials_lock`` is set.
143144
..
145+
.. versionadded:: 4.4.8 replaces ``login_lock_credentials``
146+
:Name: login_credentials_lock
147+
:Type: integer
148+
:Required: no
149+
:Default: 0
150+
:Description: whether credentials can be changed by user. |br|
151+
0 = don't lock (user can change credentials) |br|
152+
1 = lock at login (user can still change credentials in account settings) |br|
153+
2 = lock at login and in account settings (user can't change credentials)
154+
..
155+
.. deprecated:: 4.4.8 replaced by ``login_credentials_lock``
144156
:Name: login_lock_credentials
145157
:Type: boolean
146158
:Required: no
147159
:Default: false
148-
:Description: whether user name and password are locked (= can't be edited by the user) in case they are provided by managed configuration
160+
:Description: whether user name and password are locked (= can't be edited by the user) in case they are provided by managed configuration.
149161
..
150162
:Name: login_certificate_alias
151163
:Type: text
@@ -263,6 +275,7 @@ These variables can be used for Managed DAVx⁵ configuration:
263275
1 = show only collections in the user's own home-sets
264276

265277

278+
266279
Configuration file syntax
267280
=========================
268281

0 commit comments

Comments
 (0)