cloudflared-mon

Cloudflared-Mon is a python based Cloudflare Zero Tunnel monitoring. With Cloudflare you will be notified when tunnel health has changed.

Components and Frameworks used in cloudflared-mon:

• Loguru For logging.
• pyTelegramBotAPI For the Bot.
• schedule For scheduling route checks.

Installation

Before we can start working with Cloudflared-Mon, we need to create a new telegram bot.

Create Telegram bot

How to Create a New Bot for Telegram Open Telegram messenger, sign in to your account or create a new one.

Enter @Botfather in the search tab and choose this bot (Official Telegram bots have a blue checkmark beside their name.)

Click Start to activate BotFather bot.

In response, you receive a list of commands to manage bots. Choose or type the /newbot command and send it.

Choose a name for your bot your subscribers will see it in the conversation. And choose a username for your bot the bot can be found by its username in searches. The username must be unique and end with the word bot.

After you choose a suitable name for your bot the bot is created. You will receive a message with a link to your bot t.me/<bot_username>, recommendations to set up a profile picture, description, and a list of commands to manage your new bot.

Docker

Cloudflared-Mon is a docker based application that can be installed using docker compose:

version: "3.7"
services:
  cloudflared-mon:
    image: techblog/cloudflared-mon
    container_name: cloudflared-mon
    restart: always
    environment:
      - CHECK_INTERVALS=60
      - NOTIFIERS=
      - CF_TOKEN=
      - CF_EMAIL=
      - CF_ACCOUNT_ID=
    volumes:
      - ./cloudflared-mon/db:/app/db

Environment

• CHECK_INTERVALS - Optional. Time in seconds between checks. Default is set to 60.
• NOTIFIERS - Set the nofitications, using APPRIS.
• CF_TOKEN - Your cloudflare account token. this can be found on your cloudflare profile. Make sure to create Token with read only permissions Read here how
• CF_EMAIL - Your cloudflare account email address.
• CF_ACCOUNT_ID - Your cloudflare account ID. The account id is part of the URL: https://dash.cloudflare.com/xxd00270exxxxxxxxxxxxxxxxxxxxxxx

Volumes

Cloudflare-Mon is using sqlite database to save and monitor the Tunnels state. Use docker persistent storage to keep the db after update or changes.

Supported Notifications

The section identifies all of the services supported by this library. Check out the wiki for more information on the supported modules here.

Popular Notification Services

The table below identifies the services this tool supports and some example service urls you need to use in order to take advantage of it. Click on any of the services listed below to get more details on how you can configure Apprise to access them.