https://github.com/codidact/uptime
Uptime monitoring tool, updating StatusPage on current reachability status
https://github.com/codidact/uptime
Last synced: 2 months ago
JSON representation
Uptime monitoring tool, updating StatusPage on current reachability status
- Host: GitHub
- URL: https://github.com/codidact/uptime
- Owner: codidact
- License: mit
- Created: 2020-12-15T16:44:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T21:00:05.000Z (11 months ago)
- Last Synced: 2025-04-18T11:03:32.247Z (11 months ago)
- Language: Ruby
- Size: 25.4 KB
- Stars: 2
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# uptime
Simple self-hosted configurable up-or-down checking tool, sending notifications via email (for example to StatusPage) or
Discord webhook.
## Install
You'll need Ruby and Bundler installed as a prerequisite.
* `git clone` this repo and `cd` into it.
* `bundle install`
## Usage
Copy the sample config file to `config.yml` and set it up. You'll need access credentials for SES,
and you'll need to configure your monitors. Follow the comments in the file and it shouldn't be too
difficult.
Once you've got it set up, use `ruby monitor.rb` to run it. It'll run forever, or until you Ctrl-C
it. You can also set it up as a service for unattended running.
## Development & Contributing
Follow the [Install](#install) steps to set up for development. Contributions are welcome - please
target the `master` branch for your pull request. If you intend to add significant or breaking
changes, it is encouraged to open an issue first so that your intentions can be discussed.
Contributions and contributors must follow the
[Codidact Code of Conduct](https://github.com/codidact/uptime?tab=coc-ov-file).
## License
MIT licensed.