Managed configurations
Available on: all plan levels
Use managed configurations to customize or enforce certain Client settings across your workforce. In general, most settings are available for all platforms, but some are platform-specific. Each key below lists its supported platforms and the minimum Client version for each platform.
For guidance on distributing and provisioning the Clients themselves, see the MDM Provisioning guide.
Once a key has been set, the user will not be able to change that particular setting in the Client UI. To allow the user to change the setting, you must unset the key from the managed configuration.
Values supplied by a managed policy, such as accountSlug, are read-only in
the Firezone Client. Users cannot override them while the policy is applied.
Available keys
Each version below is the minimum supported Firezone Client version. Platforms not listed for a key
do not support it. Android keys also apply to the Android Client on ChromeOS.
Key names are case-sensitive: Android uses authUrl and apiUrl, while macOS,
iOS, and Windows use authURL and apiURL.
authURL / authUrl
- Supported Clients: macOS, iOS, Windows, Android: 1.5.0+
- Type:
String - Default:
https://app.firezone.dev
The base auth URL of the Firezone application to sign in to. Set to https://eu.app.firezone.dev for Firezone Cloud EU. The accountSlug will be appended to this to form the complete sign-in URL.
apiURL / apiUrl
- Supported Clients: macOS, iOS, Windows, Android: 1.5.0+
- Type:
String - Default:
wss://api.firezone.dev
The WebSocket URL of the Firezone control plane. Set to wss://eu.api.firezone.dev for Firezone Cloud EU.
logFilter
- Supported Clients: macOS, Windows, iOS, Android: 1.5.0+
- Type:
String - Default:
info
The RUST_LOG-formatted log filter to apply to the connectivity library logger. Increasing the log level here can help troubleshoot connectivity issues at the cost of increased log file sizes and performance if very verbose logging (i.e. TRACE) is specified.
accountSlug
- Supported Clients: macOS, Windows, iOS, Android: 1.5.0+
- Type:
String - Default:
<empty>
The account slug or ID of your Firezone account.
startOnLogin
- Supported Clients: macOS, Android: 1.5.0+; Windows: 1.5.21+
- Type:
Boolean - Default:
false
Whether the client should start automatically on login.
connectOnStart
- Supported Clients: macOS, Windows, iOS, Android: 1.5.0+
- Type:
Boolean - Default:
false
Whether the client should connect automatically on start.
disableUpdateCheck
- Supported Clients: macOS (standalone): 1.5.0+
- Type:
Boolean - Default:
false
Whether to disable the periodic update checker. The update checker is enabled by default for standalone macOS Clients.
checkForUpdates
- Supported Clients: Windows: 1.5.0+
- Type:
Boolean - Default:
true
Enable or disable the periodic update checker. The update checker is enabled by default for Windows Clients.
hideAdminPortalMenuItem
- Supported Clients: macOS, Windows: 1.5.0+
- Type:
Boolean - Default:
false
Whether to show or hide the admin portal link in the main menu.
hideResourceList
- Supported Clients: macOS, iOS: 1.5.10+
- Type:
Boolean - Default:
false
Whether to show or hide the resource list in the main menu.
supportURL
- Supported Clients: macOS, iOS, Windows: 1.5.0+
- Type:
String - Default:
https://www.firezone.dev/support
The destination URL used for the support link in the main menu.
To apply these keys through your MDM provider, see Configuring the Client in the MDM Provisioning guide.
Need help? See all support options.