Skip to content

Commit a2ca9ef

Browse files
sunkupsunkup
authored
Change config variables table to field lists (#40)
1 parent 79b3673 commit a2ca9ef

File tree

1 file changed

+183
-122
lines changed

1 file changed

+183
-122
lines changed

‎managed_davx5.rst

+183-122
Original file line numberDiff line numberDiff line change
@@ -74,132 +74,193 @@ Configuration variables
7474

7575
These variables can be used for Managed DAVx⁵ configuration:
7676

77-
.. list-table:: Configuration variables
78-
:header-rows: 1
79-
80-
* - Name
81-
- Type
82-
- Description
83-
* - license
84-
- text*
85-
- license data (JSON without surrounding curly brackets)
86-
* - license_signature
87-
- text*
88-
- license signature (Base64)
89-
* - organization
90-
- text
91-
- organization display name; shown in app drawer and login activity
92-
* - logo_url
93-
- text (URL)
94-
- organization logo; shown in login activity; must be publicly accessible without authentication
95-
* - support_homepage_url
96-
- text (URL)
97-
- 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
98-
* - support_email_address
99-
- text (email address)
100-
- internal support email address – shown in app drawer and some notifications
101-
* - support_phone_number
102-
- text (phone number)
103-
- internal support phone number – shown in app drawer and some notifications
104-
* - login_introduction
105-
- text (simple HTML)
106-
- message that will be shown when the user adds an account; may contain simple HTML like paragrahps, bold text and links
107-
* - login_base_url
108-
- text (URL)*
109-
- base URL for CalDAV/CardDAV service discovery when an account is added;
110-
example: ``https://server.example.com/dav/``
111-
* - login_type
112-
- text: ``DEFAULT`` (default) or ``NEXTCLOUD_LOGIN_FLOW``
113-
- ``DEFAULT`` = login with username/password/certificate |br|
114-
``NEXTCLOUD_LOGIN_FLOW`` = Nextcloud login flow
115-
* - login_user_name
116-
- text
117-
- pre-filled user name when an account is added
118-
* - login_password
119-
- text
120-
- pre-filled password when an account is added; see security note below
121-
* - login_lock_credentials
122-
- boolean
123-
- whether user name and password are locked (= can't be edited by the user) in case they are provided by managed configuration
124-
* - login_certificate_alias
125-
- text
126-
- if provided, client certificates will be used for authentication (instead of user name/password); value of this field will be pre-selected (if available)
127-
* - login_certificate_and_password
128-
- boolean
129-
- whether login should use both certificate AND username + password
130-
* - preselect_collections
131-
- integer
132-
- whether collections are automatically selected for synchronization after their initial detection |br| |br|
133-
0 = none (don't preselect) |br|
134-
1 = all (preselect if not excluded) |br|
135-
2 = :ref:`personal<Personal collections>`. (preselect if personal and not excluded)
136-
* - preselect_collections_excluded
137-
- text (regular expression)
138-
- regular expression whose matches with collection URLs will be excluded from preselection;
139-
example: ``/z-app-generated--contactsinteraction--recent/`` (Nextcloud's "Recently Contacted" addressbook; the slashes are URL path separators and not regex syntax elements)
140-
* - force_read_only_addressbooks
141-
- boolean
142-
- *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|
143-
*false* = (default) DAVx⁵ won't change standard read-only setting.
144-
* - max_accounts
145-
- integer
146-
- maximum number of accounts – no new accounts can be added when this number of accounts is reached
147-
* - proxy_type
148-
- integer
149-
- Sets the proxy type for all HTTP(S) connections. Uses ``override_proxy_host`` and ``override_proxy_port``, if applicable. |br| |br|
150-
-1 = system default |br|
151-
0 = none |br|
152-
1 = HTTP |br|
153-
2 = SOCKS
154-
* - override_proxy_host
155-
- text (host name)
156-
- HTTP proxy host name
157-
* - override_proxy_port
158-
- integer (port number)
159-
- HTTP proxy port number
160-
* - default_sync_interval
161-
- integer (number of seconds)
162-
- 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|
163-
Can always be overwritten by users. Changing this value will only affect newly added accounts.
164-
* - wifi_only
165-
- boolean
166-
- *true* = DAVx⁵ will only sync when a WiFi connection is active (doesn't apply to manually forced synchronization) |br|
167-
*false* = DAVx⁵ will sync regardless of the connection type
168-
* - wifi_only_ssids
169-
- text (comma-separated list)
170-
- when set, DAVx⁵ will only sync when device is connected to one of these WiFis;
171-
only used when wifi_only is true;
172-
example: ``wifi1,wifi2,wifi3``
173-
* - contact_group_method
174-
- text: ``CATEGORIES`` or ``GROUP_VCARDS`` (default)
175-
- ``CATEGORIES`` = contact groups are stored as per-contact category tags |br|
176-
``GROUP_VCARDS`` = contact groups are separate VCards
177-
* - manage_calendar_colors
178-
- boolean
179-
- *true* = DAVx⁵ will overwrite local calendar colors with the server colors at every sync |br|
180-
*false* = DAVx⁵ won't change local calendar colors at every sync
181-
* - event_colors
182-
- boolean
183-
- *true* = DAVx⁵ will synchronize event colors |br|
184-
*false* = DAVx⁵ won't synchronize event colors |br| |br|
185-
Setting to *true* causes some default calendar apps to crash → make sure that your preferred calendar app is working with this setting
186-
* - default_alarm
187-
- integer (number of minutes)
188-
- 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|
189-
Can always be overwritten by users. Changing this value will only affect newly downloaded events.
190-
* - show_only_personal
191-
- integer
192-
- -1 (default value) = user can choose |br|
193-
0 = show all collections |br|
194-
1 = show only collections in the user's own home-sets
195-
196-
197-
198-
\*... required
77+
:Name: license
78+
:Type: text
79+
:Required: yes
80+
:Description: license data (JSON without surrounding curly brackets)
81+
..
82+
:Name: license_signature
83+
:Type: text
84+
:Required: yes
85+
:Description: license signature (Base64)
86+
..
87+
:Name: organization
88+
:Type: text
89+
:Required: no
90+
:Description: organization display name; shown in app drawer and login activity
91+
..
92+
:Name: logo_url
93+
:Type: text (URL)
94+
:Required: no
95+
:Description: organization logo; shown in login activity; must be publicly accessible without authentication
96+
..
97+
:Name: support_homepage_url
98+
:Type: text (URL)
99+
:Required: no
100+
: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
101+
..
102+
:Name: support_email_address
103+
:Type: text (email address)
104+
:Required: no
105+
:Description: internal support email address – shown in app drawer and some notifications
106+
..
107+
:Name: support_phone_number
108+
:Type: text (phone number)
109+
:Required: no
110+
:Description: internal support phone number – shown in app drawer and some notifications
111+
..
112+
:Name: login_introduction
113+
:Type: text (simple HTML)
114+
:Required: no
115+
:Description: message that will be shown when the user adds an account; may contain simple HTML like paragrahps, bold text and links
116+
..
117+
:Name: login_base_url
118+
:Type: text (URL)
119+
:Required: yes
120+
:Description: base URL for CalDAV/CardDAV service discovery when an account is added; example: ``https://server.example.com/dav/``
121+
..
122+
:Name: login_type
123+
:Type: text
124+
:Required: no
125+
:Default: DEFAULT
126+
:Description:
127+
``DEFAULT`` = login with username/password/certificate |br|
128+
``NEXTCLOUD_LOGIN_FLOW`` = Nextcloud login flow
129+
..
130+
:Name: login_user_name
131+
:Type: text
132+
:Required: no
133+
:Description: pre-filled user name when an account is added
134+
..
135+
:Name: login_password
136+
:Type: text
137+
:Required: no
138+
:Description: pre-filled password when an account is added; see security note below
199139

200140
.. warning::
201141
Using ``login_password`` is only recommended with app-specific per-user passwords. Keep in mind that the user
202142
may be able to retrieve the password even if ``login_lock_credentials`` is set.
143+
..
144+
:Name: login_lock_credentials
145+
:Type: boolean
146+
:Required: no
147+
: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
149+
..
150+
:Name: login_certificate_alias
151+
:Type: text
152+
:Required: no
153+
: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)
154+
..
155+
:Name: login_certificate_and_password
156+
:Type: boolean
157+
:Required: no
158+
:Description: whether login should use both certificate AND username + password
159+
..
160+
:Name: preselect_collections
161+
:Type: integer
162+
:Required: no
163+
:Default: 0
164+
:Description: whether collections are automatically selected for synchronization after their initial detection |br|
165+
0 = none (don't preselect) |br|
166+
1 = all (preselect if not excluded) |br|
167+
2 = :ref:`personal<Personal collections>`. (preselect if personal and not excluded)
168+
..
169+
:Name: preselect_collections_excluded
170+
:Type: text (regular expression)
171+
:Required: no
172+
:Description: regular expression whose matches with collection URLs will be excluded from preselection; |br|
173+
example: ``/z-app-generated--contactsinteraction--recent/`` (Nextcloud's "Recently Contacted" addressbook; the slashes are URL path separators and not regex syntax elements)
174+
..
175+
:Name: force_read_only_addressbooks
176+
:Type: boolean
177+
:Required: no
178+
:Default: false
179+
:Description:
180+
*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|
181+
*false* = DAVx⁵ won't change standard read-only setting.
182+
..
183+
:Name: max_accounts
184+
:Type: integer
185+
:Required: no
186+
:Description: maximum number of accounts – no new accounts can be added when this number of accounts is reached
187+
..
188+
:Name: proxy_type
189+
:Type: integer
190+
:Required: no
191+
:Default: -1
192+
:Description: Sets the proxy type for all HTTP(S) connections. Uses ``override_proxy_host`` and ``override_proxy_port``, if applicable. |br|
193+
-1 = system default |br|
194+
0 = none |br|
195+
1 = HTTP |br|
196+
2 = SOCKS
197+
..
198+
:Name: override_proxy_host
199+
:Type: text (host name)
200+
:Required: no
201+
:Description: HTTP proxy host name
202+
..
203+
:Name: override_proxy_port
204+
:Type: integer (port number)
205+
:Required: no
206+
:Description: HTTP proxy port number
207+
..
208+
:Name: default_sync_interval
209+
:Type: integer (number of seconds)
210+
:Required: no
211+
:Default: 14400 seconds (4 hours)
212+
: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|
213+
Can always be overwritten by users. Changing this value will only affect newly added accounts.
214+
..
215+
:Name: wifi_only
216+
:Type: boolean
217+
:Required: no
218+
:Default: *false*
219+
:Description: *true* = DAVx⁵ will only sync when a WiFi connection is active (doesn't apply to manually forced synchronization) |br|
220+
*false* = DAVx⁵ will sync regardless of the connection type
221+
..
222+
:Name: wifi_only_ssids
223+
:Type: text (comma-separated list)
224+
:Required: no
225+
:Description: when set, DAVx⁵ will only sync when device is connected to one of these WiFis; only used when wifi_only is true; |br|
226+
example: ``wifi1,wifi2,wifi3``
227+
..
228+
:Name: contact_group_method
229+
:Type: text
230+
:Required: no
231+
:Default: ``GROUP_VCARDS``
232+
:Description: ``CATEGORIES`` = contact groups are stored as per-contact category tags |br|
233+
``GROUP_VCARDS`` = contact groups are separate VCards
234+
..
235+
:Name: manage_calendar_colors
236+
:Type: boolean
237+
:Required: no
238+
:Default: *false*
239+
:Description: *true* = DAVx⁵ will overwrite local calendar colors with the server colors at every sync |br|
240+
*false* = DAVx⁵ won't change local calendar colors at every sync
241+
..
242+
:Name: event_colors
243+
:Type: boolean
244+
:Required: no
245+
:Default: *false*
246+
:Description: *true* = DAVx⁵ will synchronize event colors |br|
247+
*false* = DAVx⁵ won't synchronize event colors |br|
248+
Setting to *true* causes some default calendar apps to crash → make sure that your preferred calendar app is working with this setting
249+
..
250+
:Name: default_alarm
251+
:Type: integer (number of minutes)
252+
:Required: no
253+
:Default: -1
254+
: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|
255+
Can always be overwritten by users. Changing this value will only affect newly downloaded events.
256+
..
257+
:Name: show_only_personal
258+
:Type: integer
259+
:Required: no
260+
:Default: -1
261+
:Description: -1 = user can choose |br|
262+
0 = show all collections |br|
263+
1 = show only collections in the user's own home-sets
203264

204265

205266
Configuration file syntax

0 commit comments

Comments
 (0)