Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.28 KB

README.md

File metadata and controls

112 lines (76 loc) · 3.28 KB
Raw

🐤 Updo - Website Monitoring Tool

Updo demo

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.

Language:Go License:MIT Latest Release

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

Screen.Recording.2024-01-05.at.4.02.27.PM.mov

Installation

Download executable binaries

You can download executable binaries from the latest release page:

Latest Release

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 #4

Usage

Run Updo using the following command:

./updo [options] --url <website-url>

Docker

You can run Updo using Docker:

docker build -t updo .
docker run -it updo [options] --url <website-url>

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 --refresh=10 --should-fail=false --url https://example.com

Keyboard Shortcuts

  • q or Ctrl+C: Quit the application

Mentions

Contributing

Contributions to Updo are welcome! Feel free to create issues or submit pull requests.

License

This project is licensed under the MIT License.