PayloadKit

Firezone

dev.firezone.firezone

Manage configuration for the Firezone macOS client.

macOS

Configuration Keys (10)

KeyTypeTitle
authURL

The base URL to open when users click "Sign in". The accountSlug will be appended to this.

Default: "https://app.firezone.dev"

stringAuthentication URL
apiURL

The WebSocket URL of the Firezone control plane to connect to.

Default: "wss://api.firezone.dev"

stringWebSocket API URL
logFilter

The RUST_LOG-style filter string to apply to the connectivity library for increasing log output to use for connectivity troubleshooting.

Default: "info"

stringRUST_LOG filter string
accountSlug

Your Firezone account ID or slug which will be appended to the authURL to form the complete sign in URL. Will be set automatically by the client after the first successful authentication.

stringAccount ID or Slug
hideAdminPortalMenuItem

Hide the Admin portal link in the Firezone menu in the macOS menu bar.

Default: false

booleanHide admin portal link
hideResourceList

Hide the resource list in the Firezone menu in the macOS menu bar.

Default: false

booleanHide resource list
connectOnStart

Try to connect to Firezone using the saved token and configuration when the client application starts. If the authentication token is expired, the client will start in a disconnected state.

Default: false

booleanConnect on start
startOnLogin

Start the Firezone client when the user logs into the machine. Requires the Firezone client to be running to take effect. In many cases you probably want to configure this using a Managed Login Items payload instead to force the client to be running.

Default: false

booleanStart on login
disableUpdateCheck

Disables the update check and notification for the Standalone variant of the macOS client. App Store variant versions 1.4.15 and higher already have this disabled.

Default: false

booleanDisable update check
supportURL

The URL to which users will be taken to when clicking the Help -> Support link in the menu bar.

Default: "https://www.firezone.dev/support"

stringSupport URL