info.md

Cloudflare Tunnel Monitor Home Assistant Integration

Description

This custom integration for Home Assistant allows users to monitor the status of their Cloudflare Tunnels directly from their Home Assistant instance. The integration fetches the status of Cloudflare Tunnels and presents it as sensor entities in Home Assistant.

Installation

Via HACS (Home Assistant Community Store)

1. Navigate to the HACS page on your Home Assistant instance.
2. Go to the "Integrations" tab and click the "Explore & Add Repositories" button.
3. Search for "Cloudflare Tunnel Monitor" and select it.
4. Click on "Install this repository in HACS".
5. Restart your Home Assistant instance.

Manual Installation

1. Clone this repository or download the zip file.
2. Copy the cloudflare_tunnel_monitor directory from the custom_components directory in this repository to the custom_components directory on your Home Assistant instance.
3. Restart your Home Assistant instance.

Configuration

Cloudflare Setup

1. Copy your Account ID.

2. Create an API Token.

Via UI

1. Navigate to "Configuration" -> "Integrations" -> "+".
2. Search for "Cloudflare Tunnel Monitor" and select it.
3. Fill in the required information and click "Submit".

Configuration Variables

• api_key: Your Cloudflare API Token with Account:Cloudflare Tunnel:Read permissions
• account_id: Your Cloudflare Account ID.

Usage

Upon successful configuration, the integration will create sensor entities for each Cloudflare Tunnel. These sensors will reflect the current status of each tunnel.

Support

If you encounter any issues or require further assistance, please raise an issue on this GitHub repository.

License

This integration is released under the MIT License.

Disclaimer

This project is not affiliated with or endorsed by Cloudflare.