README
¶
🐤 Updo - Website Monitoring Tool
Updo is a command-line tool for monitoring website uptime and performance. It provides real-time metrics on website status, response time, SSL certificate expiry, and more, with alert notifications.
Features
- Real-time monitoring of website uptime and performance
- Displays various metrics like uptime percentage, average response time, and SSL certificate expiry
- Desktop alert notifications for website status changes
- Customizable refresh intervals and request timeouts
- Supports HTTP and HTTPS, with options to skip SSL verification
- Assertion on response body content
Demo
https://github.com/Owloops/updo/assets/17541283/5edd2eb1-af81-4b88-96e2-643c80d46aca
Installation
Download executable binaries
You can download executable binaries from the latest release page:
Build from source
You can install Updo by cloning the repository and building the binary:
Make sure your system has Go installed.
git clone https://github.com/Owloops/updo.git cd updo go build
Another way to install it if you have go in your machine just:
GOBIN="absolute_path_where_you_want_binaries_to_be_installed" go install github.com/Owloops/updo@latest
[!NOTE]
You may get a warning message on Windows and MacOS, which is discussed in this issue https://github.com/Owloops/updo/issues/4
Usage
Run Updo using the following command:
./updo --url <website-url> [options]
Options
--url: URL of the website to monitor (required)--refresh: Refresh interval in seconds (default: 5)--should-fail: Invert status code success (default: false)--timeout: HTTP request timeout in seconds (default: 10)--follow-redirects: Follow redirects (default: true)--skip-ssl: Skip SSL certificate verification (default: false)--assert-text: Text to assert in the response body--receive-alert: Enable alert notifications (default: true)--help: Display help message
Example
./updo --url https://example.com --refresh=10 --should-fail=false
Keyboard Shortcuts
qorCtrl+C: Quit the application
Contributing
Contributions to Updo are welcome! Feel free to create issues or submit pull requests.
License
This project is licensed under the MIT License.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.