updu Documentation

Welcome to the documentation for updu! Here you will find detailed guides on how to configure and use the various monitor types available in updu.

Overview

updu is a lightweight, self-hosted uptime monitoring solution designed specifically for homelabs and small infrastructure. It’s built to run essentially anywhere (even on a Raspberry Pi Zero W) while providing all the essential monitoring features you need without the bloat.

Available Monitor Types

Select a monitor type below to learn more about its configuration options:

• HTTP / HTTPS - Monitor web endpoints, status codes, and response bodies.
• TCP Port - Verify services are accepting connections on specific ports.
• DNS - Validate DNS record resolution.
• ICMP / Ping - Check low-level host reachability.
• SSH - Verify SSH connectivity to remote machines.
• SSL Certificate - Track certificate expiry dates.
• JSON API - Deep-check API responses by validating JSON fields.
• Push (Heartbeat) - Passive monitoring endpoint for cron jobs and external scripts.
• WebSocket - Verify WebSocket and WSS connection upgrades.
• SMTP Server - Check email server health and TLS support.
• UDP Port - Send and receive datagrams.
• Redis - Ping Redis instances and check authentication.
• PostgreSQL - Verify Postgres database connectivity.
• MySQL - Verify MySQL and MariaDB database connectivity.
• MongoDB - Verify MongoDB document database connectivity.

Configuration

All monitor configuration in updu is done directly through the embedded web dashboard. When you add a new monitor, you'll be presented with specific fields relevant to that monitor type. The guides in this documentation explain each of these fields in detail.