Configuration

⚠️ It is recommended (and easier) to use the Homebridge UI plugin settings screen to configure the plugin. The settings screen is generated from the same source as this page, and always reflects the full, current set of options.

This page is for reference and for users who edit their configuration JSON manually.

Required Settings

Add the following to your configuration file inside the platforms array.

{
   "name": "CloudflaredTunnel",
   "acceptCloudflareNotice": true,
   "platform": "CloudflaredTunnel"
}

• ⚠️ The "platform": "CloudflaredTunnel" line must not be changed
• The plugin runs a Cloudflare tunnel to expose your chosen local service - the notice must be accepted for the tunnel to start.

Optional Settings

Setting	Type	Default	Explanation
domain	string	-	The domain of the self specified tunnel.
token	string	-	The token to use for the self specified tunnel.
acceptCloudflareNotice	boolean	-	Automatically start the Cloudflared Tunnel install process.
url	string	``	The URL to tunnel to. If you are using a URL, you do not need to specify the protocol, hostname, or port.
protocol	string	``	The protocol to use for the tunnel. If you are using a URL, you do not need to specify the protocol, hostname, or port.
hostname	string	-	The hostname to tunnel to. If you are using a URL, you do not need to specify the protocol, hostname, or port.
port	number	-	The port to tunnel to. If you are using a URL, you do not need to specify the protocol, hostname, or port.
verifyTLS	boolean	false	Verify the TLS certificate of the origin server.
logging	string	``	Plugin Logging Setting
enableMatter	boolean	true	Enable Matter mode for this plugin. In Matter mode, the plugin publishes only the Matter tunnel status accessory endpoint.