Skip to content

Latest commit

聽

History

History
169 lines (117 loc) 路 4.33 KB

File metadata and controls

169 lines (117 loc) 路 4.33 KB

OpenStatus

The Open-Source synthetic monitoring platform.
Learn more 禄

Discord 路 Website 路 Issues

About OpenStatus 馃彄

OpenStatus is open-source synthetic monitoring platform.

  • Synthetic monitoring: Monitor your website and APIs globally and receive notifications when they are down or slow.

Recognitions 馃弳

openstatusHQ%2Fopenstatus | Trendshift

Featured on Hacker News

Contact us 馃拰

If you are interested in our enterprise plan or need special features, please email us at ping@openstatus.dev or book a call

Book us with Cal.com

Contributing 馃

If you want to help us building the best status page and alerting system, you can check our contributing guidelines

Top Contributors

Made with Contrib.rocks

Stats

Alt

Tech stack 馃

Built with Depot

Getting Started 馃殌

With Docker (Recommended)

The fastest way to get started for both development and self-hosting:

# 1. Copy environment file
cp .env.docker.example .env.docker

# 2. Start all services
docker compose up -d

# 3. Access the application
open http://localhost:3002  # Dashboard
open http://localhost:3003  # Status Pages

馃摉 Full guide: DOCKER.md

With Devbox

You can use Devbox and get started with the following commands:

  1. Install Devbox
    curl -fsSL https://get.jetify.com/devbox | bash
  2. Install project dependencies, build and start services
    devbox services up

Manual Setup

Requirements

Setup

  1. Clone the repository
git clone https://github.com/openstatushq/openstatus.git
  1. Install dependencies
pnpm install
  1. Initialize the development environment

Launch the database in one terminal:

turso dev --db-file openstatus-dev.db

In another terminal, run the following command:

pnpm dx
  1. Launch whatever app you wish to:
pnpm dev:web
pnpm dev:status-page
pnpm dev:dashboard

The above commands whill automatically run the libSQL client on 8080 so you might wanna kill the turso command from step 3.

  1. See the results:

Videos

Videos to better understand the OpenStatus codebase: