khadanja/wanipmonitor repository overview

Docker Image: WAN IP Monitor with Telegram Notifications Overview

This Docker image monitors changes in the WAN (public) IP address and sends notifications via Telegram when a change is detected. It uses cron to schedule the monitoring script (monitor_ip.sh) to run at defined intervals. Features

Automatic IP Monitoring: Checks WAN IP address changes using ipify API.
Telegram Notifications: Sends notifications to a Telegram chat when IP changes are detected.
Flexible Configuration: Configurable through environment variables for Telegram API credentials and IP monitoring frequency.

Usage

1. Pull the Docker Image

Pull the latest version of the image from Docker Hub: docker pull your-dockerhub-username/wan-ip-monitor:latest

1. Set Up Environment Variables

Before running the container, set the necessary environment variables:

TELEGRAM_BOT_TOKEN: Your Telegram Bot API token.
TELEGRAM_CHAT_ID: Your Telegram chat ID or channel ID where notifications will be sent.
IPIFY_URL: (Optional) URL for fetching the WAN IP. Defaults to https://api.ipify.org/?format=json.
CRON_SCHEDULE: (Optional) Cron schedule for running the IP monitoring script. Defaults to "0 * * * *" (every hour).

Example using Docker Compose:

services: wan-ip-monitor: image: khadanja/wanipmonitor:latest environment: - TELEGRAM_BOT_TOKEN=your_telegram_bot_token - TELEGRAM_CHAT_ID=your_telegram_chat_id - IPIFY_URL=https://api.ipify.org/?format=json⁠ - CRON_SCHEDULE="0 * * * *" # Run every hour (default) volumes: - path/to/log/:/var/log