openstatus
OpenStatus Documentation
Learn how to create your status page, monitor your services, and keep your users informed — all open source.
What is openstatus?
Section titled “What is openstatus?”openstatus is an open-source status page platform with uptime monitoring. Monitor your websites, APIs, and services from multiple global locations and share real-time status updates with your users.
Why OpenStatus?
Section titled “Why OpenStatus?”- Open source — fully open-source, self-hostable, and transparent
- Beautiful status pages — keep your users informed with public or audience specific status pages
- 30+ global locations — monitor from your users’ perspective, not just your own
- HTTP, TCP & DNS monitors — check APIs, servers, and DNS resolution
- 12 notification channels — Slack, Discord, PagerDuty, OpsGenie, email, SMS, and more
- Monitoring as code — define monitors in YAML, manage with CLI or Terraform
- OpenTelemetry export — send metrics to Grafana, Datadog, Honeycomb, or any OTLP endpoint
- Private locations — deploy lightweight probes inside your own infrastructure
How to use this documentation
Section titled “How to use this documentation”Our documentation follows the Diátaxis framework, organizing content into four distinct categories to help you find what you need:
📚 Tutorials Step-by-step lessons to learn openstatus from scratch. Start here if you're new!
🛠️ How-to Guides Practical guides to solve specific problems and accomplish particular tasks.
💡 Concepts In-depth explanations of key concepts, design decisions, and best practices.
📖 Reference Technical specifications, API documentation, and configuration references.
Not sure where to start?
- New users: Begin with our tutorials to create your first monitor
- Experienced users: Check out how-to guides for specific tasks
- Need help? Visit our help section or join our community
Join the community
Section titled “Join the community”Join the community to get help, share your ideas or just to say hi.