Skip to main content
Open source · MIT licensed · Self-hosted

Peekaping docs

Uptime monitoring you run on your own server. Check websites, APIs, databases and queues, get alerts where your team already talks, and publish status pages.

Get started Try the live demo
Peekaping monitor page: current status, a heartbeat bar, uptime for 24 hours to 365 days and a response time chart

Start here​

Quick start

One container, SQLite, no Redis. Up and running in a minute.

Deployment modes

Single mode or cluster mode, and how to pick between them.

Kubernetes (Helm)

Run cluster mode on Kubernetes with the Helm chart.

Architecture

How the API server, probes and storage fit together.

Badges

Embed live status and uptime badges in READMEs and sites.

Development

Set up a local environment and contribute.

Beta

Peekaping is in beta and under active development. Some features may be incomplete or change, so test it outside production first. Please report any issues you find: your feedback is what makes Peekaping production-ready.

Key features​

Monitoring types

HTTP/HTTPS, TCP ports, ping (ICMP), DNS, push heartbeats to a generated URL, and Docker containers.

Real-time dashboard

Live updates over WebSocket, interactive charts, 24-hour uptime, response times and heartbeat history.

Smart notifications

Email (SMTP), Slack, Telegram, webhooks, Ntfy and PagerDuty. Retries before a monitor goes down, resend intervals, and alerts only when the status changes.

Status pages

Public status pages you can brand with your own styling, to share service status with your users.

Advanced features

Maintenance windows, HTTP proxies, 2FA sign-in, and automatic cleanup of old heartbeat data.

Live demo

Try Peekaping in the browser before you install it.

Architecture​

Peekaping is built with modern technologies:

  • Backend: Go with strong typing and dependency injection
  • Frontend: React with TypeScript
  • Database: SQLite or PostgreSQL for data persistence
  • Real-time: WebSocket connections for live updates
  • API: RESTful API with OpenAPI documentation
  • Deployment: single mode, one process with no Redis, is the default for new installs. Cluster mode, with separate API and probe processes (the API replicas talk through Redis, and the probes run the checks), is for installs that need to scale out, on Kubernetes with Helm or with Docker Compose. See Deployment modes

Why Peekaping?​

Peekaping is designed as a modern alternative to Uptime Kuma, built with a focus on:

  • Strongly Typed Architecture - Both Go backend and TypeScript frontend
  • Extensibility - Modular design for easy feature additions
  • Performance - Go's efficiency enables high performance with low resource usage
  • Developer Experience - Clean code structure and comprehensive documentation

Community​

  • GitHub: 0xfurai/peekaping
  • Issues: Report bugs and request features
  • Discussions: Join the community discussions
  • Twitter: @0xfurai for updates and tips

Ready to start monitoring? Try our live demo to see Peekaping in action.