Simple Go project to track current public IP and notify changes to a telegram bot
Find a file
Melora Hugues 7cd3703b33 Improve CI
Add more tests to the CI, including a docker build test, and add the
generation and publication of a new docker image on master and tags
2023-02-02 20:40:35 +01:00
tracker Allow asking for the current public IP 2023-01-29 18:50:43 +01:00
.drone.yml Improve CI 2023-02-02 20:40:35 +01:00
.gitignore Create initial Go module 2023-01-05 18:51:53 +01:00
Dockerfile Add multi-architecture support 2023-01-29 18:19:54 +01:00
LICENSE Initial commit 2023-01-05 09:49:25 +01:00
README.md Add Dockerfile 2023-01-28 15:11:36 +01:00

Public IP tracker

Build Status

Telegram bot that detects changes to the device's public IP. This is particularily useful when the device is handled by an ISP that does not provide a static public IP, such as a home device.

Features

Automatic public IP detection and monitoring

Upon startup, the current public IP is detected, and a status message is sent to a specific Telegram channel with the relevant information.

Insert example message here

When running as a daemon, the program automatically monitors the current public IP adress for changes. If the IP changes for some reason, then the new updated adress is sent to the specific Telegram channel.

Insert example message here

On-demand public IP

The relevant channel is monitored during the program execution. This allows the user to send a command to the bot in order to get the current public IP on-demand.

Insert example here

Deploy

Configuration file

For now, the program is configured through a JSON configuration file. Here is a sample :

{
    "telegram": {
        "token": "<your_bot_token>",
        "channel_id": 9999999
    },
    "polling_frequency": 5
}

Docker

You can use the provided Dockerfile to build your own image.

docker build -t public-ip-tracker .

You can then use the provided configuration file sample, and provide it to the program using the /config volume

I might add support for environment variables in the future.

docker run -it -v /path/to/your/dir/with/json/file:/config public-ip-tracker