UptimeKit

The modern open-source status page and monitoring solution.

Features • Getting Started • Tech Stack • Contributing

✨ Features

UptimeKit is designed to be the all-in-one solution for tracking your services' uptime and communicating with your users.

• 📊 Monitoring - Real-time uptime monitoring for your HTTP/TCP services.
• 🚦 Status Pages - Beautiful, customizable status pages for your users.
• 🔔 Incidents - Create and manage incident reports to keep users informed.
• 🏢 Organizations - Multi-tenant support with team management.
• 📈 Analytics - Detailed uptime and response time metrics.
• 🛠️ Self-Hostable - Full control over your data and infrastructure.

How it works

Uptimekit is a distributed monitoring solution. You can have as many workers as you want and as many replicas of the app as you want. The workers check with the app every 15 seconds to get their assigned monitors and run the checks whenever they have to.

🚀 Tech Stack

Built with a modern, type-safe stack for maximum performance and developer experience.

• Framework: Next.js 16 (App Router)
• Language: TypeScript
• Database: PostgreSQL with Drizzle ORM & ClickHouse & TimescaleDB
• Styling: TailwindCSS & shadcn/ui
• Authentication: Better-Auth
• API: oRPC & OpenAPI
• Monorepo: Turborepo

🛠️ Getting Started

Follow these steps to get UptimeKit running locally on your machine.

Prerequisites

• Redis
• Clickhouse/Timescale
• PostgreSQL

Install

1. Download the docker-compose.yml

    curl -o docker-compose.yml https://raw.githubusercontent.com/uptimekit/uptimekit/main/docker-compose.yml

2. Start the docker compose

    docker-compose up -d

3. Now follow the steps on the app. Enjoy :D

Manual installation

1. Clone the repository

    git clone https://github.com/uptimekit/uptimekit.git
    cd uptimekit

2. Install dependencies

    pnpm install

3. Environment Setup

   Copy the .env.example file in .env

4. Database Setup

   Push the schema to your database:

    pnpm run db:push

5. Run Development Server

   Start all applications (Dashboard, Status Page, Marketing/Docs):

    pnpm run dev

   • Dashboard: http://localhost:3000
   • Status Page: http://localhost:3001

📂 Project Structure

uptimekit/
├── apps/
│   ├── dash/          # Main Dashboard application
│   ├── worker/        # Probe who actually pings the monitors
│   └── status-page/   # Public Status Page application
├── packages/
│   ├── api/           # Shared API definition & logic
│   ├── auth/          # Authentication configuration
│   ├── db/            # Database schema & Drizzle config
│   ├── scheduler/     # Scheduler application
│   └── config/        # Shared configuration (TS, ESLint, etc.)
└── ....

💝 Sponsors

Thank you to all our amazing sponsors who make this project possible!

Become a sponsor and get your logo here!

👀 Previews

Default theme with length bars

Flat theme with length bars

Signal theme with signal bars

🤝 Contributing

We welcome contributions! Please check out our Contributing Guide for details on how to submit pull requests, report issues, and request features.

📄 License

This project is licensed under a MIT License