Managed configurations
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. The table below lists the available managed configuration keys and to which platforms they apply.
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.
Available keys
| Key | Type | Default Value | Description | Available on | Available since |
|---|---|---|---|---|---|
authURL | String | https://app.firezone.dev | The base auth URL of the Firezone application to sign in to. The accountSlug will be appended to this to form the complete sign-in URL. | macOS, Windows, iOS, Android | 1.5.0 |
apiURL | String | wss://api.firezone.dev | The WebSocket URL of the Firezone control plane. | macOS, Windows, iOS, Android | 1.5.0 |
logFilter | String | 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. | macOS, Windows, iOS, Android | 1.5.0 |
accountSlug | String | <empty> | The account slug or ID of your Firezone account. | macOS, Windows, iOS, Android | 1.5.0 |
startOnLogin | Boolean | false | Whether the client should start automatically on login. | macOS, Android | 1.5.0 |
connectOnStart | Boolean | false | Whether the client should connect automatically on start. | macOS, Windows, iOS, Android | 1.5.0 |
disableUpdateCheck | Boolean | false | Whether to disable the periodic update checker. The update checker is enabled by default for standalone macOS Clients. | macOS, iOS, Android | 1.5.0 |
checkForUpdates | Boolean | false | Enable or disable the periodic update checker. The update checker is enabled by default for Windows Clients. | Windows | 1.5.0 |
hideAdminPortalMenuItem | Boolean | false | Whether to show or hide the admin portal link in the main menu. | macOS, Windows | 1.5.0 |
hideResourceList | Boolean | false | Whether to show or hide the resource list in the main menu. | macOS, iOS | 1.5.10 |
supportURL | String | https://www.firezone.dev/support | The destination URL used for the support link in the main menu. | macOS, iOS, Windows | 1.5.0 |
To apply these keys through your MDM provider, see Configuring the Client in the MDM Provisioning guide.
Need help? See all support options.