1-init-project #7
1 changed files with 28 additions and 2 deletions
30
README.md
30
README.md
|
@ -1,3 +1,29 @@
|
||||||
# public-ip-tracker
|
# Public IP tracker
|
||||||
|
|
||||||
Simple Go project to track current public IP and notify changes to a telegram bot
|
[![Build Status](https://drone.faercol.me/api/badges/faercol/public-ip-tracker/status.svg)](https://drone.faercol.me/faercol/public-ip-tracker)
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
|
Loading…
Reference in a new issue