You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: managed_davx5.rst
+34-36
Original file line number
Diff line number
Diff line change
@@ -76,74 +76,72 @@ These variables can be used for Managed DAVx⁵ configuration.
76
76
77
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.
78
78
79
-
:Name: license
79
+
:Name:``license``
80
80
:Type: text
81
81
:Required: yes
82
82
:Description: license data (JSON without surrounding curly brackets)
83
83
..
84
-
:Name: license_signature
84
+
:Name:``license_signature``
85
85
:Type: text
86
86
:Required: yes
87
87
:Description: license signature (Base64)
88
88
..
89
-
:Name: organization
89
+
:Name:``organization``
90
90
:Type: text
91
91
:Required: no
92
92
:Description: organization display name; shown in app drawer and login activity
93
93
..
94
-
:Name: logo_url
94
+
:Name:``logo_url``
95
95
:Type: text (URL)
96
96
:Required: no
97
97
:Description: organization logo; shown in login activity; must be publicly accessible without authentication
98
98
..
99
-
:Name: support_homepage_url
99
+
:Name:``support_homepage_url``
100
100
:Type: text (URL)
101
101
:Required: no
102
102
: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
103
103
..
104
-
:Name: support_email_address
104
+
:Name:``support_email_address``
105
105
:Type: text (email address)
106
106
:Required: no
107
107
:Description: internal support email address – shown in app drawer and some notifications
108
108
..
109
-
:Name: support_phone_number
109
+
:Name:``support_phone_number``
110
110
:Type: text (phone number)
111
111
:Required: no
112
112
:Description: internal support phone number – shown in app drawer and some notifications
113
113
..
114
-
:Name: login_introduction
114
+
:Name:``login_introduction``
115
115
:Type: text (simple HTML)
116
116
:Required: no
117
117
:Description: message that will be shown when the user adds an account; may contain simple HTML like paragrahps, bold text and links
118
118
..
119
-
:Name: login_base_url
119
+
:Name:``login_base_url``
120
120
:Type: text (URL)
121
121
:Required: yes
122
122
:Description: base URL for CalDAV/CardDAV service discovery when an account is added; example: ``https://server.example.com/dav/``
123
123
..
124
-
:Name: login_type
124
+
:Name:``login_type``
125
125
:Type: text
126
126
:Required: no
127
-
:Default: DEFAULT
127
+
:Default:``DEFAULT``
128
128
:Description:
129
129
``DEFAULT`` = login with username/password/certificate |br|
130
130
``NEXTCLOUD_LOGIN_FLOW`` = Nextcloud login flow
131
131
..
132
-
:Name: login_user_name
132
+
:Name:``login_user_name``
133
133
:Type: text
134
134
:Required: no
135
135
:Description: pre-filled user name when an account is added
136
136
..
137
-
:Name: login_password
137
+
:Name:``login_password``
138
138
:Type: text
139
139
: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.
@@ -153,23 +151,23 @@ If they are specific to a certain version, this is mentioned before the variable
153
151
2 = lock at login and in account settings (user can't change credentials)
154
152
..
155
153
.. deprecated:: 4.4.8 replaced by ``login_credentials_lock``
156
-
:Name: login_lock_credentials
154
+
:Name:``login_lock_credentials``
157
155
:Type: boolean
158
156
:Required: no
159
157
:Default: false
160
158
:Description: whether user name and password are locked (= can't be edited by the user) in case they are provided by managed configuration.
161
159
..
162
-
:Name: login_certificate_alias
160
+
:Name:``login_certificate_alias``
163
161
:Type: text
164
162
:Required: no
165
163
: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)
166
164
..
167
-
:Name: login_certificate_and_password
165
+
:Name:``login_certificate_and_password``
168
166
:Type: boolean
169
167
:Required: no
170
168
:Description: whether login should use both certificate AND username + password
171
169
..
172
-
:Name: preselect_collections
170
+
:Name:``preselect_collections``
173
171
:Type: integer
174
172
:Required: no
175
173
:Default: 0
@@ -178,26 +176,26 @@ If they are specific to a certain version, this is mentioned before the variable
178
176
1 = all (preselect if not excluded) |br|
179
177
2 = :ref:`personal<Personal collections>`. (preselect if personal and not excluded)
180
178
..
181
-
:Name: preselect_collections_excluded
179
+
:Name:``preselect_collections_excluded``
182
180
:Type: text (regular expression)
183
181
:Required: no
184
182
:Description: regular expression whose matches with collection URLs will be excluded from preselection; |br|
185
183
example: ``/z-app-generated--contactsinteraction--recent/`` (Nextcloud's "Recently Contacted" addressbook; the slashes are URL path separators and not regex syntax elements)
186
184
..
187
-
:Name: force_read_only_addressbooks
185
+
:Name:``force_read_only_addressbooks``
188
186
:Type: boolean
189
187
:Required: no
190
188
:Default: false
191
189
:Description:
192
190
*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|
193
191
*false* = DAVx⁵ won't change standard read-only setting.
194
192
..
195
-
:Name: max_accounts
193
+
:Name:``max_accounts``
196
194
:Type: integer
197
195
:Required: no
198
196
:Description: maximum number of accounts – no new accounts can be added when this number of accounts is reached
199
197
..
200
-
:Name: proxy_type
198
+
:Name:``proxy_type``
201
199
:Type: integer
202
200
:Required: no
203
201
:Default: -1
@@ -207,66 +205,66 @@ If they are specific to a certain version, this is mentioned before the variable
207
205
1 = HTTP |br|
208
206
2 = SOCKS
209
207
..
210
-
:Name: override_proxy_host
208
+
:Name:``override_proxy_host``
211
209
:Type: text (host name)
212
210
:Required: no
213
211
:Description: HTTP proxy host name
214
212
..
215
-
:Name: override_proxy_port
213
+
:Name:``override_proxy_port``
216
214
:Type: integer (port number)
217
215
:Required: no
218
216
:Description: HTTP proxy port number
219
217
..
220
-
:Name: default_sync_interval
218
+
:Name:``default_sync_interval``
221
219
:Type: integer (number of seconds)
222
220
:Required: no
223
221
:Default: 14400 seconds (4 hours)
224
222
: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|
225
223
Can always be overwritten by users. Changing this value will only affect newly added accounts.
226
224
..
227
-
:Name: wifi_only
225
+
:Name:``wifi_only``
228
226
:Type: boolean
229
227
:Required: no
230
228
:Default: *false*
231
229
:Description: *true* = DAVx⁵ will only sync when a WiFi connection is active (doesn't apply to manually forced synchronization) |br|
232
230
*false* = DAVx⁵ will sync regardless of the connection type
233
231
..
234
-
:Name: wifi_only_ssids
232
+
:Name:``wifi_only_ssids``
235
233
:Type: text (comma-separated list)
236
234
:Required: no
237
235
:Description: when set, DAVx⁵ will only sync when device is connected to one of these WiFis; only used when wifi_only is true; |br|
238
236
example: ``wifi1,wifi2,wifi3``
239
237
..
240
-
:Name: contact_group_method
238
+
:Name:``contact_group_method``
241
239
:Type: text
242
240
:Required: no
243
241
:Default: ``GROUP_VCARDS``
244
242
:Description: ``CATEGORIES`` = contact groups are stored as per-contact category tags |br|
245
243
``GROUP_VCARDS`` = contact groups are separate VCards
246
244
..
247
-
:Name: manage_calendar_colors
245
+
:Name:``manage_calendar_colors``
248
246
:Type: boolean
249
247
:Required: no
250
248
:Default: *false*
251
249
:Description: *true* = DAVx⁵ will overwrite local calendar colors with the server colors at every sync |br|
252
250
*false* = DAVx⁵ won't change local calendar colors at every sync
253
251
..
254
-
:Name: event_colors
252
+
:Name:``event_colors``
255
253
:Type: boolean
256
254
:Required: no
257
255
:Default: *false*
258
256
:Description: *true* = DAVx⁵ will synchronize event colors |br|
Setting to *true* causes some default calendar apps to crash → make sure that your preferred calendar app is working with this setting
261
259
..
262
-
:Name: default_alarm
260
+
:Name:``default_alarm``
263
261
:Type: integer (number of minutes)
264
262
:Required: no
265
263
:Default: -1
266
264
: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|
267
265
Can always be overwritten by users. Changing this value will only affect newly downloaded events.
0 commit comments