8. Managed DAVx⁵

Managed DAVx⁵ is a version of DAVx⁵ that contains mass-deployment and configuration features for organizations.

8.1. Managed configuration

Managed DAVx⁵ allows you to manage DAVx⁵ clients centrally by using these configuration methods (in order of precedence):

  • Android Enterprise (recommended)

  • network configuration: fixed URL (QR code)

This configuration is used in the Managed DAVx⁵ UI and for new Managed DAVx⁵ accounts.

Note

Existing Managed DAVx⁵ accounts on your devices won’t be modified when the managed configuration is changed.

8.2. Configuration by Android Enterprise

Android Enterprise is the recommended method to configure Managed DAVx⁵. With Android Enterprise, IT departments can deploy apps to managed devices and configure them in a standardized way using MDM software. Apps are configured by managed configurations (sometimes called restrictions) which can be set in the MDM software for every deployed app.

Screenshot of Managed DAVx⁵ configuration over an MDM

You can configure Managed DAVx⁵ using MDM/EMM software.

8.3. Network configuration

Network configuration requires your Android devices to be connected to the network where the configuration file can be found.

8.3.1. Configuration by fixed URL

The simplest method to configure Managed DAVx⁵ over the network is to use a fixed configuration file URL, which can for example be provided as a QR code. This method can be used if you don’t want to use automatic discovery of the Managed DAVx⁵ configuration file:

  1. Upload the Managed DAVx⁵ configuration file to a HTTPS server in the network (file name: davdroid-config.json)

  2. Managed DAVx⁵ / Managed configuration / Scan the QR code of the configuration file URL or enter the URL.

8.3.2. Certificates

When accessing the configuration file, PKI is used to verify the TLS certificate, so a self-signed certificate won’t work without adding it to the Android device first. We recommend to put the configuration file to a location which is accessible over a trusted certificate. You can then define custom trusted certificates in the configuration file.

8.3.3. Caching

Two types of caching are used to cache Managed DAVx⁵ configuration when it’s taken from the network:

  1. configuration cache and

  2. HTTP cache.

Configuration cache:

Managed DAVx⁵ caches the configuration file which is fetched from the network so that Managed DAVx⁵ configuration is available when there is no network access (and for the time when Managed DAVx⁵ has been started, but the new network configuration is not ready yet). The cache will be overwritten when a new configuration file is downloaded. To reset the cache without a new configuration file, use: Managed DAVx⁵ / About/License / Managed configuration / Reload configuration.

HTTP cache:

The configuration file is cached when it has been downloaded from the network according to the rules of the HTTP protocol. For instance, if the Web server which hosts the configuration file returns a freshness period of one hour, Managed DAVx⁵ will always use the cached version for one hour. However, the configuration file will be downloaded at least once a day (max-age: 1 day) to avoid problems caused by obsolete configuration files. If there is no Expires, the cache will use If-Match and If-Unmodified-Since.

It’s advisable to set an expiration time for the configuration file on the Web server (for instance, one hour) explicitly to avoid unnecessary network traffic every time Managed DAVx⁵ is started on a device.

8.4. Configuration variables

These variables can be used for Managed DAVx⁵ configuration:

Configuration variables

Name

Type

Description

license

text*

license data (JSON without surrounding curly brackets)

license_signature

text*

license signature (Base64)

organization

text

organization display name; shown in app drawer and login activity

logo_url

text (URL)

organization logo; shown in login activity; must be publicly accessible without authentication

support_homepage_url

text (URL)

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

support_email_address

text (email address)

internal support email address – shown in app drawer and some notifications

support_phone_number

text (phone number)

internal support phone number – shown in app drawer and some notifications

login_introduction

text (simple HTML)

message that will be shown when the user adds an account; may contain simple HTML like paragrahps, bold text and links

login_base_url

text (URL)*

base URL for CalDAV/CardDAV service discovery when an account is added; example: https://server.example.com/dav/

login_type

text: DEFAULT (default) or NEXTCLOUD_LOGIN_FLOW

DEFAULT = login with username/password/certificate
NEXTCLOUD_LOGIN_FLOW = Nextcloud login flow

login_user_name

text

pre-filled user name when an account is added

login_password

text

pre-filled password when an account is added; see security note below

login_lock_credentials

boolean

whether user name and password are locked (= can’t be edited by the user) in case they are provided by managed configuration

login_certificate_alias

text

if provided, client certificates will be used for authentication (instead of user name/password); value of this field will be pre-selected (if available)

login_certificate_and_password

boolean

whether login should use both certificate AND username + password

preselect_collections

integer

whether collections are automatically selected for synchronization after their initial detection

0 = none (don’t preselect)
1 = all (preselect if not excluded)
2 = personal. (preselect if personal and not excluded)

preselect_collections_excluded

text (regular expression)

regular expression whose matches with collection URLs will be excluded from preselection; example: /z-app-generated--contactsinteraction--recent/ (Nextcloud’s “Recently Contacted” addressbook; the slashes are URL path separators and not regex syntax elements)

force_read_only_addressbooks

boolean

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.
false = (default) DAVx⁵ won’t change standard read-only setting.

max_accounts

integer

maximum number of accounts – no new accounts can be created when this number of accounts is reached

proxy_type

integer

Sets the proxy type for all HTTP(S) connections. Uses override_proxy_host and override_proxy_port, if applicable.

-1 = system default
0 = none
1 = HTTP
2 = SOCKS

override_proxy_host

text (host name)

HTTP proxy host name

override_proxy_port

integer (port number)

HTTP proxy port number

default_sync_interval

integer (number of seconds)

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).
Can always be overwritten by users. Changing this value will only affect newly created accounts.

wifi_only

boolean

true = DAVx⁵ will only sync when a WiFi connection is active (doesn’t apply to manually forced synchronization)
false = DAVx⁵ will sync regardless of the connection type

wifi_only_ssids

text (comma-separated list)

when set, DAVx⁵ will only sync when device is connected to one of these WiFis; only used when wifi_only is true; example: wifi1,wifi2,wifi3

contact_group_method

text: CATEGORIES or GROUP_VCARDS (default)

CATEGORIES = contact groups are stored as per-contact category tags
GROUP_VCARDS = contact groups are separate VCards

manage_calendar_colors

boolean

true = DAVx⁵ will overwrite local calendar colors with the server colors at every sync
false = DAVx⁵ won’t change local calendar colors at every sync

event_colors

boolean

true = DAVx⁵ will synchronize event colors
false = DAVx⁵ won’t synchronize event colors

Setting to true causes some default calendar apps to crash → make sure that your preferred calendar app is working with this setting

default_alarm

integer (number of minutes)

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
Can always be overwritten by users. Changing this value will only affect newly downloaded events.

show_only_personal

integer

-1 (default value) = user can choose
0 = show all collections
1 = show only collections in the user’s own home-sets

*… required

Warning

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_lock_credentials is set.

8.5. Configuration file syntax

For the network or local file configuration method, a Managed DAVx⁵ configuration file is required. It contains configuration variables in JSON format, like this:

{
  "license": "<escaped JSON, don't change this>",
  "license_signature": "<don't change this>",
  "organization": "bitfire",
  "logo_url": "https://intranet.example.com/your-logo.png",
  "support_homepage_url": "https://intranet.example.com/how-to-use-davdroid",
  "support_email_address": "it-support@example.com",
  "support_phone_number": "+1 234 56789",
  "login_base_url": "https://caldav+carddav.example.com/",
  "max_accounts": 1,
  "override_proxy": false,
  "wifi_only": true,
  "wifi_only_ssids": "wifi1,wifi2",
  "contact_group_method": "GROUP_VCARDS",
  "manage_calendar_colors": true,
  "default_sync_interval": 3600,
  "event_colors": false
}