Lightweight uptime monitoring and reporting tool for FreeBSD.
If you're looking for a simple monitoring tool that can be setup in less than a minute, keep reading! uptimebot monitors IP addresses, ports, http servers, changes in DNS records and expiration date of TLS certificates. When stuff breaks, you will be notified via log or a Telegram bot.
- Extremely easy to setup and use.
- Supports both IPv4 & IPv6.
- Supports A, AAAA, CNAME, TXT, MX, NS, SOA and PTR records.
- Outputs alerts to log and Telegram.
- Uses basic shell and FreeBSD tools.
- Automatic cronjob creation.
You can install uptimebot with botmanager. Or manually as follows:
wget https://raw.githubusercontent.com/nozel-org/freebsd-uptimebot/master/uptimebot -O /usr/local/bin/uptimebot
chown root:wheel /usr/local/bin/uptimebot
chmod 555 /usr/local/bin/uptimebot
wget https://raw.githubusercontent.com/nozel-org/freebsd-uptimebot/master/uptimebot.conf -O /usr/local/etc/uptimebot/uptimebot.conf
chown root:wheel /usr/local/etc/uptimebot/uptimebot.conf
chmod 755 /usr/local/etc/uptimebot/uptimebot.conf
wget https://raw.githubusercontent.com/nozel-org/freebsd-uptimebot/master/targets.conf -O /usr/local/etc/uptimebot/targets.conf
chown root:wheel /usr/local/etc/uptimebot/targets.conf
chmod 755 /usr/local/etc/uptimebot/targets.conf
When installed, add a monitoring target to /usr/local/etc/uptimebot/targets.conf and fire away by running uptimebot --all --cli.
General settings and automated tasks can be configured in /usr/local/etc/uptimebot/uptimebot.conf. Automated tasks can be effectuated with uptimebot --cron. Monitoring targets can be set in /usr/local/etc/uptimebot/targets.conf.conf.
uptimebot has features, methods and options. Options can be used standalone, but a feature always requires a method and vice versa. Some examples:"
# options
$ uptimebot --help # Displays help text
$ uptimebot --cron # Effectuates automated tasks
# features/methods
$ uptimebot --all --list # Shows an overview of all configured monitoring targets
$ uptimebot --ping --cli # Runs the ping feature and outputs to CLI and log
$ uptimebot --port --logonly # Runs the port feature and outputs only to log
$ uptimebot --http --telegram # Runs the http feature and outputs to Telegram and log
For a full list of features, methods and options run uptimebot --help.
If you have questions, suggestions or find bugs, please let us know via the issue tracker.
1.4.2-RELEASE (22-08-2023)
- Fixed incorrect indents.
1.4.1-RELEASE (01-02-2023)
- Moved configuration files to /usr/local/etc/uptimebot.
- Renamed uptimebot_targets.conf to targets.conf.
- Replaced install script with botmanager.
1.4.0-RELEASE (28-04-2022)
- Renamed method logonly to log.
- Made method list consistent with the method cli output.
- Fixed a bug in feature tls that would generate errors for already expired certificates.
- Added a basic check for monitoring target validity.
- Added requirement check for curl.
- Added inverted functionality to feature port.
1.3.0-RELEASE (27-04-2022)
- Added feature TLS.
- Added emoji to method Telegram.
1.2.0-RELEASE (26-04-2022)
- Got rid of similar pieces of code by combining functions.
- Fixed a lot of shellcheck warnings and errors.
- Added check for telegram configuration.
1.1.0-RELEASE (25-04-2022)
- Added feature DNS with support for A, AAAA, CNAME, TXT, MX, NS, SOA and PTR records.
- Delay between monitoring actions (to prevent flooding) is now configurable.
- Logging output layout is now more consistent across all methods.
- Made certain checks more efficient to speed up the program.
- Feature port now supports both IPv4 and IPv6 (configurable).
- Changed default cron values.
1.0.0-RELEASE (24-04-2022)
- Added basic program framework.
- Added configuration file.
- Added configuration file for monitoring targets.
- Added automatic cron jobs for automated tasks.
- Added logging of monitoring results.
- Added ping monitoring feature.
- Added port monitoring feature.
- Added http monitoring feature.
- Added all monitoring feature.
- Added method list.
- Added method logonly.
- Added method CLI.
- Added method Telegram.