Skip to content

Commit 3c29a10

Browse files
committed
Managed variables: use monotype; make password warning less alerting
1 parent 1249b67 commit 3c29a10

File tree

1 file changed

+34
-36
lines changed

1 file changed

+34
-36
lines changed

managed_davx5.rst

+34-36
Original file line numberDiff line numberDiff line change
@@ -76,74 +76,72 @@ These variables can be used for Managed DAVx⁵ configuration.
7676

7777
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.
7878

79-
:Name: license
79+
:Name: ``license``
8080
:Type: text
8181
:Required: yes
8282
:Description: license data (JSON without surrounding curly brackets)
8383
..
84-
:Name: license_signature
84+
:Name: ``license_signature``
8585
:Type: text
8686
:Required: yes
8787
:Description: license signature (Base64)
8888
..
89-
:Name: organization
89+
:Name: ``organization``
9090
:Type: text
9191
:Required: no
9292
:Description: organization display name; shown in app drawer and login activity
9393
..
94-
:Name: logo_url
94+
:Name: ``logo_url``
9595
:Type: text (URL)
9696
:Required: no
9797
:Description: organization logo; shown in login activity; must be publicly accessible without authentication
9898
..
99-
:Name: support_homepage_url
99+
:Name: ``support_homepage_url``
100100
:Type: text (URL)
101101
:Required: no
102102
:Description: URL of intranet page with details on how to use Managed DAVx⁵ in this organization and how to get internal support; shown in app drawer
103103
..
104-
:Name: support_email_address
104+
:Name: ``support_email_address``
105105
:Type: text (email address)
106106
:Required: no
107107
:Description: internal support email address – shown in app drawer and some notifications
108108
..
109-
:Name: support_phone_number
109+
:Name: ``support_phone_number``
110110
:Type: text (phone number)
111111
:Required: no
112112
:Description: internal support phone number – shown in app drawer and some notifications
113113
..
114-
:Name: login_introduction
114+
:Name: ``login_introduction``
115115
:Type: text (simple HTML)
116116
:Required: no
117117
:Description: message that will be shown when the user adds an account; may contain simple HTML like paragrahps, bold text and links
118118
..
119-
:Name: login_base_url
119+
:Name: ``login_base_url``
120120
:Type: text (URL)
121121
:Required: yes
122122
:Description: base URL for CalDAV/CardDAV service discovery when an account is added; example: ``https://server.example.com/dav/``
123123
..
124-
:Name: login_type
124+
:Name: ``login_type``
125125
:Type: text
126126
:Required: no
127-
:Default: DEFAULT
127+
:Default: ``DEFAULT``
128128
:Description:
129129
``DEFAULT`` = login with username/password/certificate |br|
130130
``NEXTCLOUD_LOGIN_FLOW`` = Nextcloud login flow
131131
..
132-
:Name: login_user_name
132+
:Name: ``login_user_name``
133133
:Type: text
134134
:Required: no
135135
:Description: pre-filled user name when an account is added
136136
..
137-
:Name: login_password
137+
:Name: ``login_password``
138138
:Type: text
139139
:Required: no
140-
:Description: pre-filled password when an account is added; see security note below
141-
.. warning::
142-
Using ``login_password`` is only recommended with app-specific per-user passwords. Keep in mind that the user
143-
may be able to retrieve the password even if ``login_credentials_lock`` is set.
140+
:Description: pre-filled password when an account is added |br|
141+
Using ``login_password`` is only recommended with app-specific per-user passwords. Keep in mind that the user may be able to retrieve the password even if ``login_credentials_lock`` is set.
144142
..
145143
.. versionadded:: 4.4.8 replaces ``login_lock_credentials``
146-
:Name: login_credentials_lock
144+
:Name: ``login_credentials_lock``
147145
:Type: integer
148146
:Required: no
149147
:Default: 0
@@ -153,23 +151,23 @@ If they are specific to a certain version, this is mentioned before the variable
153151
2 = lock at login and in account settings (user can't change credentials)
154152
..
155153
.. deprecated:: 4.4.8 replaced by ``login_credentials_lock``
156-
:Name: login_lock_credentials
154+
:Name: ``login_lock_credentials``
157155
:Type: boolean
158156
:Required: no
159157
:Default: false
160158
:Description: whether user name and password are locked (= can't be edited by the user) in case they are provided by managed configuration.
161159
..
162-
:Name: login_certificate_alias
160+
:Name: ``login_certificate_alias``
163161
:Type: text
164162
:Required: no
165163
:Description: if provided, client certificates will be used for authentication (instead of user name/password); value of this field will be pre-selected (if available)
166164
..
167-
:Name: login_certificate_and_password
165+
:Name: ``login_certificate_and_password``
168166
:Type: boolean
169167
:Required: no
170168
:Description: whether login should use both certificate AND username + password
171169
..
172-
:Name: preselect_collections
170+
:Name: ``preselect_collections``
173171
:Type: integer
174172
:Required: no
175173
:Default: 0
@@ -178,26 +176,26 @@ If they are specific to a certain version, this is mentioned before the variable
178176
1 = all (preselect if not excluded) |br|
179177
2 = :ref:`personal<Personal collections>`. (preselect if personal and not excluded)
180178
..
181-
:Name: preselect_collections_excluded
179+
:Name: ``preselect_collections_excluded``
182180
:Type: text (regular expression)
183181
:Required: no
184182
:Description: regular expression whose matches with collection URLs will be excluded from preselection; |br|
185183
example: ``/z-app-generated--contactsinteraction--recent/`` (Nextcloud's "Recently Contacted" addressbook; the slashes are URL path separators and not regex syntax elements)
186184
..
187-
:Name: force_read_only_addressbooks
185+
:Name: ``force_read_only_addressbooks``
188186
:Type: boolean
189187
:Required: no
190188
:Default: false
191189
:Description:
192190
*true* = DAVx⁵ will set all address books to read-only. This will only prevent *client side* editing of contacts from DAVx⁵. If any changes are made they will be reverted to the version present on the server. Keep in mind that this is not preventing changes to the address book in general. For instance other apps can still change the address book on the server. |br|
193191
*false* = DAVx⁵ won't change standard read-only setting.
194192
..
195-
:Name: max_accounts
193+
:Name: ``max_accounts``
196194
:Type: integer
197195
:Required: no
198196
:Description: maximum number of accounts – no new accounts can be added when this number of accounts is reached
199197
..
200-
:Name: proxy_type
198+
:Name: ``proxy_type``
201199
:Type: integer
202200
:Required: no
203201
:Default: -1
@@ -207,66 +205,66 @@ If they are specific to a certain version, this is mentioned before the variable
207205
1 = HTTP |br|
208206
2 = SOCKS
209207
..
210-
:Name: override_proxy_host
208+
:Name: ``override_proxy_host``
211209
:Type: text (host name)
212210
:Required: no
213211
:Description: HTTP proxy host name
214212
..
215-
:Name: override_proxy_port
213+
:Name: ``override_proxy_port``
216214
:Type: integer (port number)
217215
:Required: no
218216
:Description: HTTP proxy port number
219217
..
220-
:Name: default_sync_interval
218+
:Name: ``default_sync_interval``
221219
:Type: integer (number of seconds)
222220
:Required: no
223221
:Default: 14400 seconds (4 hours)
224222
:Description: initial sync interval at account creation (contacts/calendars/tasks); default value: 14400 seconds (4 hours). Only these values are eligible: 900 (15 min), 1800 (30 min), 3600 (1 h), 7200 (2 h), 14400 (4 h), 86400 (1 day). |br|
225223
Can always be overwritten by users. Changing this value will only affect newly added accounts.
226224
..
227-
:Name: wifi_only
225+
:Name: ``wifi_only``
228226
:Type: boolean
229227
:Required: no
230228
:Default: *false*
231229
:Description: *true* = DAVx⁵ will only sync when a WiFi connection is active (doesn't apply to manually forced synchronization) |br|
232230
*false* = DAVx⁵ will sync regardless of the connection type
233231
..
234-
:Name: wifi_only_ssids
232+
:Name: ``wifi_only_ssids``
235233
:Type: text (comma-separated list)
236234
:Required: no
237235
:Description: when set, DAVx⁵ will only sync when device is connected to one of these WiFis; only used when wifi_only is true; |br|
238236
example: ``wifi1,wifi2,wifi3``
239237
..
240-
:Name: contact_group_method
238+
:Name: ``contact_group_method``
241239
:Type: text
242240
:Required: no
243241
:Default: ``GROUP_VCARDS``
244242
:Description: ``CATEGORIES`` = contact groups are stored as per-contact category tags |br|
245243
``GROUP_VCARDS`` = contact groups are separate VCards
246244
..
247-
:Name: manage_calendar_colors
245+
:Name: ``manage_calendar_colors``
248246
:Type: boolean
249247
:Required: no
250248
:Default: *false*
251249
:Description: *true* = DAVx⁵ will overwrite local calendar colors with the server colors at every sync |br|
252250
*false* = DAVx⁵ won't change local calendar colors at every sync
253251
..
254-
:Name: event_colors
252+
:Name: ``event_colors``
255253
:Type: boolean
256254
:Required: no
257255
:Default: *false*
258256
:Description: *true* = DAVx⁵ will synchronize event colors |br|
259257
*false* = DAVx⁵ won't synchronize event colors |br|
260258
Setting to *true* causes some default calendar apps to crash → make sure that your preferred calendar app is working with this setting
261259
..
262-
:Name: default_alarm
260+
:Name: ``default_alarm``
263261
:Type: integer (number of minutes)
264262
:Required: no
265263
:Default: -1
266264
:Description: number of minutes a default reminder will be created before the start of every non-full-day event without reminder; no value (null) or value -1: no default reminders |br|
267265
Can always be overwritten by users. Changing this value will only affect newly downloaded events.
268266
..
269-
:Name: show_only_personal
267+
:Name: ``show_only_personal``
270268
:Type: integer
271269
:Required: no
272270
:Default: -1

0 commit comments

Comments
 (0)