PayloadKit

Firezone

dev.firezone.firezone

Manage configuration for the Firezone macOS client.

macOS

Configuration Keys (10)

Showing 10 of 10 keys

KeyTypeDescriptionDefaultRange
authURLstring

Authentication URL

stringThe base URL to open when users click "Sign in". The accountSlug will be appended to this.Default: "https://app.firezone.dev"Range: —
apiURLstring

WebSocket API URL

stringThe WebSocket URL of the Firezone control plane to connect to.Default: "wss://api.firezone.dev"Range: —
logFilterstring

RUST_LOG filter string

stringThe RUST_LOG-style filter string to apply to the connectivity library for increasing log output to use for connectivity troubleshooting.Default: "info"Range: —

Account ID or Slug

stringYour 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.Default: —Range: —

Hide admin portal link

booleanHide the Admin portal link in the Firezone menu in the macOS menu bar.Default: falseRange: —

Hide resource list

booleanHide the resource list in the Firezone menu in the macOS menu bar.Default: falseRange: —

Connect on start

booleanTry 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: falseRange: —

Start on login

booleanStart 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: falseRange: —

Disable update check

booleanDisables 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: falseRange: —

Support URL

stringThe URL to which users will be taken to when clicking the Help -> Support link in the menu bar.Default: "https://www.firezone.dev/support"Range: —