Guides

Overview

Practical guides for integrating openstatus with GitHub Actions, OTLP endpoints, Cloudflare, and more.

How to Configure Your Status Page

A step-by-step tutorial to customize and configure your status page

How to Create Your Own Status Page Theme

A step-by-step guide to designing, testing, and contributing a community theme for openstatus status pages.

How to Import a Status Page from Another Provider

Import your existing status page setup from Atlassian Statuspage, Better Stack, or Instatus into openstatus

How to translate your status page

Enable multiple languages on your status page and contribute new translations.

How to Embed a Status Page in an Iframe

Embed a trimmed, chromeless version of your openstatus status page on any website using the `?embed` query parameter.

How to Add a Status Badge to a GitHub README

A step-by-step guide to adding a real-time SVG or PNG status badge to your GitHub repository.

How to Use openstatus React Widget

Add an openstatus status widget to your React or Next.js app with the @openstatus/react package, as a server or client component.

How to Monitor Your Model Context Provider (MCP) Server

Learn how to monitor your MCP server with openstatus using JSON-RPC ping checks

How to Run Synthetic Tests in GitHub Actions

Integrate openstatus synthetic monitoring into your CI/CD pipeline

How to Export Metrics to an OTLP Endpoint

A step-by-step guide to sending openstatus metrics to your observability platform via OTLP.

How to Set Up the openstatus Slack Agent

A step-by-step tutorial to install the openstatus Slack agent and manage incidents directly from Slack

How to Auto-Post Status Updates to X and Bluesky

A step-by-step guide to deploying the statuspage-socials-notifier and cross-posting your status page updates to X (Twitter) and Bluesky.

How to Connect openstatus to Claude Code

Step-by-step tutorial to add the openstatus MCP server to Claude Code so the agent can read and manage your status pages from the terminal

How to Manage Your openstatus Stack with Terraform

Use Terraform to manage monitors, status pages, and notifications as code — version-controlled, peer-reviewed, and reproducible.

How to Create a Private Location

Set up monitoring from your own infrastructure using Docker-based private probes

How to Deploy a Private Probe on Cloudflare Containers

A step-by-step guide to deploying an openstatus private monitoring probe on Cloudflare Containers.

How to Self-Host openstatus

Complete guide to deploying openstatus on your own infrastructure

Self-Host the openstatus Status Page (Lightweight)

Deploy only the openstatus status page and dashboard on your own infrastructure, without monitoring, analytics, or background services.

How to Deploy a Status Page to Cloudflare Pages

Learn how to use openstatus monitoring data to deploy a status page on Cloudflare Pages.