System Configuration
Introduction
This page documents the system-wide configuration options available to administrators. These settings are enforced globally and are not intended to be modified by end users.
System configuration is evaluated at application start-up and always takes precedence over the application’s built-in defaults. The OpenID Connect settings are the one exception: they are applied only when, taken together, they form a valid configuration (see OpenID Connect). When they do, they replace the built-in OpenID Connect configuration entirely.
Supported Platforms and Locations
The system configuration is read from different locations depending on the operating system.
Windows (Registry)
For Windows systems, the configuration is read from the system policy registry:
HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud
macOS (System Preferences)
On macOS, the configuration is read from the system-wide preferences file:
/Library/Preferences/com.owncloud.desktopclient/owncloud.ini
The directory com.owncloud.desktopclient is the application’s reverse-domain identifier. This directory and file must be accessible to the application for reading purposes.
Configuration File Format
The configuration file uses the INI format on macOS, Linux and Unix-like systems. The file name is derived from the platform-specific locations described above. The resolved paths are:
-
macOS:
/Library/Preferences/com.owncloud.desktopclient/owncloud.ini -
Linux and Unix-like systems:
/etc/owncloud/owncloud.ini
The following example shows the file contents in either location:
[Setup]
ServerUrl=https://cloud.example.com
AllowServerUrlChange=false
[Updater]
SkipUpdateCheck=true
[OpenIDConnect]
ClientId=<your-client-id>
ClientSecret=<your-client-secret>
Ports=8080,8443
Scopes=openid offline_access email profile
Prompt=select_account consent
Windows Registry Configuration
These settings can also be applied in Windows via registry policies.
owncloud.regWindows Registry Editor Version 5.00
[HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud]
[HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud\Setup]
"ServerUrl"="https://cloud.example.com"
"AllowServerUrlChange"=dword:00000000
[HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud\Updater]
"SkipUpdateCheck"=dword:00000001
[HKEY_LOCAL_MACHINE\Software\Policies\ownCloud\ownCloud\OpenIDConnect]
"ClientId"="<your-client-id>"
"ClientSecret"="<your-client-secret>"
"Ports"="8080,8443"
"Scopes"="openid offline_access email profile"
"Prompt"="select_account consent"
Boolean registry values use DWORD where:
-
0= disabled -
1= enabled
Configuration Sections
Setup
These keys control the initial application behaviour and server enforcement.
| Key | Description | Type | Default |
|---|---|---|---|
|
Enforces a predefined server URL. When set, the account setup wizard will pre-fill the server URL. |
String |
empty |
|
Controls whether users may change the server URL. This option only applies if |
Boolean |
true |
Updater
These keys control the behaviour of the update at a global level.
| Key | Description | Type | Default |
|---|---|---|---|
|
Disables automatic update checks when enabled. Users will not be notified of new versions. When set to |
Boolean |
false |
OpenID Connect
These keys define the OpenID Connect (OIDC) authentication parameters.
Keys may be left empty or omitted; in that case the default value is used. What matters is that the keys, taken together, form a valid configuration. At a minimum, ClientId must be set to a non-empty string. Ports may be omitted or empty (the application then selects any available port) or set to a comma-separated list of port numbers.
When a valid configuration is found, the application uses these values for authentication and ignores its entire built-in OpenID Connect configuration (see the note below).
| Key | Description | Type | Default |
|---|---|---|---|
|
OpenID Connect client identifier. If not set, no other OpenID Connect settings will be considered. |
String |
empty |
|
OpenID Connect client secret. |
String |
empty |
|
Comma-separated list of local ports used for authentication callbacks. The default value of |
List |
0 |
|
Space-separated list of requested OpenID scopes. |
String |
empty |
|
Space-separated list of OpenID prompt parameters (for example |
String |
empty |
|
When a valid OpenID Connect configuration is found, it replaces the application’s built-in configuration in its entirety. The values are not merged. Any key that is not specified is used with its empty or default value, not the built-in value. For example, if only |