@homebridge-plugins/homebridge-cloudflared-tunnel
v2.1.2
Published
The Cloudflared Tunnel plugin allows you to run a Cloudflare-Tunnel for exposing your homebridge instance for remote access.
Readme
homebridge-cloudflared-tunnel
Homebridge plugin to expose your Homebridge instance for remote access via a Cloudflare Tunnel
Plugin Information
- This plugin runs a Cloudflare Tunnel so you can access your Homebridge instance remotely. The plugin:
- starts and supervises a
cloudflaredtunnel process alongside Homebridge - shows the tunnel status in HomeKit as a sensor accessory
- can use a free quick tunnel (random URL) or your own Cloudflare domain
- starts and supervises a
Prerequisites
- To use this plugin, you will need to already have:
- Node: latest version of
v22orv24- any other major version is not supported. - Homebridge:
v2- refer to link for more information and installation instructions.
- Node: latest version of
Setup
Features
- Matter support is available when running Homebridge v2.0+ with Matter enabled:
enableMatter: true(the default) uses Matter mode when the Matter runtime is available; the tunnel status is published as a Matter motion sensor endpoint.enableMatter: falseforces HAP mode; the tunnel status is published as a HomeKit occupancy sensor.- Tunnel behaviour is identical in both modes, and the plugin falls back to HAP automatically if Matter is unavailable.
Help/About
Credits
- To @donavanbecker: the original creator and maintainer of this plugin.
- To the creators/contributors of Homebridge who make this plugin possible.
Disclaimer
- I am in no way affiliated with Cloudflare and this plugin is a personal project that I maintain in my free time.
- Use this plugin entirely at your own risk - please see licence for more information.
