Home

📖 Documentation

The README tells you what tronitor does and how to start. These pages have all the other information.

Page	Contents
📦 Installation	Requirements, how to get the script, how to run it, and how to update it
🔑 Configuration	The config file and where tronitor looks for it, every setting, the environment variables, and the API keys
🚀 Usage	How to name monitors, all the options, what each action prints, upgrading from the Bash script, sample output, and exit codes
⏰ Running from cron	Maintenance windows, the Healthchecks lock files and HealthChecks-Linux, crontab lines, and what happens when something fails
🔌 Providers	Healthchecks and UptimeRobot: what each one supports, API keys, statuses, rate limits, and new monitors. How to add a provider, and the providers that were removed
🩺 Troubleshooting	What each message means, and what to do
🧪 How it is tested	The tests, and the tests that GitHub runs on each change

To contribute, read the contributing guide. The changelog lists the changes in each release.