openstatus Documentation

Status page with uptime monitoring & API monitoring as code 🫖

8,653 stars TypeScript TypeScript 1 file · ~1,218 tokens #bun#drizzle-orm#monitoring#monitoring-as-code#nextjs#observability#on-call#open-source
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy openstatus on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name openstatus -p 8080:8080 --restart always openstatus/db-migrate:latest
Configured Services & Ports
⚙️ libsql
image: ghcr.io/tursodatabase/libsql-server:latest
🔌 Ports: 8080:8080, 5001:5001
⚙️ tinybird-local
image: tinybirdco/tinybird-local:latest
🔌 Ports: 7181:7181
⚙️ db-migrate
image: openstatus/db-migrate:latest
⚙️ workflows
image: openstatus/workflows:latest
🔌 Ports: 3000:3000
⚙️ server
image: openstatus/server:latest
🔌 Ports: 3001:3000
⚙️ private-location
image: openstatus/private-location:latest
🔌 Ports: 8081:8080
⚙️ dashboard
image: openstatus/dashboard:latest
🔌 Ports: 3002:3000
⚙️ status-page
image: openstatus/status-page:latest
🔌 Ports: 3003:3000
docker-compose.yml
yaml (docker-compose.yml) 
networks:
    openstatus:
        driver: bridge
        name: openstatus

volumes:
    libsql-data:
        name: openstatus-libsql-data
    workflows-data:
        name: openstatus-workflows-data
    tinybird-clickhouse-data:
        name: openstatus-tinybird-clickhouse-data
    tinybird-redis-data:
        name: openstatus-tinybird-redis-data

services:
    # External services
    libsql:
        container_name: openstatus-libsql
        image: ghcr.io/tursodatabase/libsql-server:latest
        networks:
            - openstatus
        ports:
            - "8080:8080"
            - "5001:5001"
        volumes:
            - libsql-data:/var/lib/sqld
        environment:
            - SQLD_NODE=primary
            # Increase limits to handle multiple services without connection pooling
            - SQLD_MAX_CONCURRENT_CONNECTIONS=512
            - SQLD_MAX_CONCURRENT_REQUESTS=1024
        healthcheck:
            test:
                [
                    "CMD-SHELL",
                    'perl -e ''use IO::Socket::INET; exit(IO::Socket::INET->new(PeerAddr=>"127.0.0.1:8080",Timeout=>1) ? 0 : 1);''',
                ]
            interval: 10s
            timeout: 5s
            retries: 5
            start_period: 10s
        restart: unless-stopped
        memswap_limit: 512M
        deploy:
            resources:
                limits:
                    memory: 512M
                reservations:
                    memory: 256M

    tinybird-local:
        container_name: openstatus-tinybird
        image: tinybirdco/tinybird-local:latest
        networks:
            - openstatus
        ports:
            - "7181:7181"
        environment:
            - COMPATIBILITY_MODE=1
        volumes:
            - tinybird-clickhouse-data:/var/lib/clickhouse
            - tinybird-redis-data:/redis-data
        healthcheck:
            test: ["CMD", "curl", "-f", "-sS", "-o", "/dev/null", "http://localhost:7181/tokens"]
            interval: 15s
            timeout: 5s
            retries: 5
            start_period: 20s
        restart: unless-stopped

    # Internal Services
    # Idempotent: drizzle skips already-applied migrations on every up
    db-migrate:
        container_name: openstatus-db-migrate
        build:
            context: .
            dockerfile: packages/db/Dockerfile
        image: openstatus/db-migrate:latest
        # rebuild on every up so a stale image never skips new migrations
        pull_policy: build
        networks:
            - openstatus
        env_file:
            - .env.docker
        environment:
            - DATABASE_URL=http://libsql:8080
        depends_on:
            libsql:
                condition: service_healthy
        # retries absorb transient DB races; still settles to failure for the gates
        restart: on-failure:3

    workflows:
        container_name: openstatus-workflows
        build:
            context: .
            dockerfile: apps/workflows/Dockerfile
        image: openstatus/workflows:latest
        networks:
            - openstatus
        ports:
            - "3000:3000"
        volumes:
            - workflows-data:/app/data
        env_file:
            - .env.docker
        environment:
            - DATABASE_URL=http://libsql:8080
            - PORT=3000
        depends_on:
            db-migrate:
                condition: service_completed_successfully
            libsql:
                condition: service_healthy
        healthcheck:
            test: ["CMD", "curl", "-f", "http://localhost:3000/ping"]
            interval: 15s
            timeout: 10s
            retries: 3
            start_period: 30s
        restart: unless-stopped
        memswap_limit: 512M
        deploy:
            resources:
                limits:
                    memory: 512M
                reservations:
                    memory: 256M

    server:
        container_name: openstatus-server
        build:
            context: .
            dockerfile: apps/server/Dockerfile
        image: openstatus/server:latest
        networks:
            - openstatus
        ports:
            - "3001:3000"
        env_file:
            - .env.docker
        environment:
            - DATABASE_URL=http://libsql:8080
            - PORT=3000
        depends_on:
            db-migrate:
                condition: service_completed_successfully
            workflows:
                condition: service_healthy
            libsql:
                condition: service_healthy
        healthcheck:
            test: ["CMD", "curl", "-f", "http://localhost:3000/ping"]
            interval: 15s
            timeout: 10s
            retries: 3
            start_period: 30s
        restart: unless-stopped
        memswap_limit: 512M
        deploy:
            resources:
                limits:
                    memory: 512M
                reservations:
                    memory: 256M

    private-location:
        container_name: openstatus-private-location
        build:
            context: apps/private-location
            dockerfile: Dockerfile
        image: openstatus/private-location:latest
        networks:
            - openstatus
        ports:
            - "8081:8080"
        env_file:
            - .env.docker
        environment:
            - DB_URL=http://libsql:8080
            - TINYBIRD_URL=http://tinybird-local:7181
            - WORKFLOWS_URL=http://workflows:3000
            - GIN_MODE=release
            - PORT=8080
        depends_on:
            server:
                condition: service_healthy
        healthcheck:
            test:
                [
                    "CMD",
                    "wget",
                    "--spider",
                    "-q",
                    "http://localhost:8080/health",
                ]
            interval: 15s
            timeout: 10s
            retries: 3
            start_period: 30s
        restart: unless-stopped
        memswap_limit: 256M
        deploy:
            resources:
                limits:
                    memory: 256M
                reservations:
                    memory: 128M

    dashboard:
        container_name: openstatus-dashboard
        build:
            context: .
            dockerfile: apps/dashboard/Dockerfile
        image: openstatus/dashboard:latest
        networks:
            - openstatus
        ports:
            - "3002:3000"
        env_file:
            - .env.docker
        environment:
            - DATABASE_URL=http://libsql:8080
            - PORT=3000
            - HOSTNAME=0.0.0.0
            - AUTH_TRUST_HOST=true
        depends_on:
            db-migrate:
                condition: service_completed_successfully
            workflows:
                condition: service_healthy
            libsql:
                condition: service_healthy
            server:
                condition: service_healthy
        healthcheck:
            test: ["CMD-SHELL", "curl -f http://localhost:3000/ || exit 1"]
            interval: 15s
            timeout: 10s
            retries: 3
            start_period: 45s
        restart: unless-stopped
        memswap_limit: 512M
        deploy:
            resources:
                limits:
                    memory: 512M
                reservations:
                    memory: 256M

    status-page:
        container_name: openstatus-status-page
        build:
            context: .
            dockerfile: apps/status-page/Dockerfile
        image: openstatus/status-page:latest
        networks:
            - openstatus
        ports:
            - "3003:3000"
        env_file:
            - .env.docker
        environment:
            - DATABASE_URL=http://libsql:8080
            - PORT=3000
            - HOSTNAME=0.0.0.0
            - AUTH_TRUST_HOST=true
            - OPENSTATUS_API_URL=${OPENSTATUS_API_URL:-http://server:3000}
        depends_on:
            db-migrate:
                condition: service_completed_successfully
            workflows:
                condition: service_healthy
            libsql:
                condition: service_healthy
            server:
                condition: service_healthy
        healthcheck:
            test: ["CMD-SHELL", "curl -f http://localhost:3000/ || exit 1"]
            interval: 15s
            timeout: 10s
            retries: 3
            start_period: 45s
        restart: unless-stopped
        memswap_limit: 512M
        deploy:
            resources:
                limits:
                    memory: 512M
                reservations:
                    memory: 256M

CONTRIBUTING

Contribution Guidelines

Thank you for considering contributing to this project! We appreciate your efforts to make it better.

To contribute to this project, please follow these guidelines:

Table of Contents

Reporting Issues

If you encounter any problems or bugs while using this project, please report them by opening a GitHub issue. Before creating a new issue, please check if a similar one already exists to avoid duplicates. When reporting issues, provide a clear and concise description of the problem, including steps to reproduce it, expected behavior, and any relevant screenshots or error messages.

Feature Requests

If you have ideas for new features or improvements, you can submit a GitHub issue as well. Clearly describe the feature or improvement you would like to see and provide any additional context or examples that might be helpful. Feature requests help us understand your needs and prioritize the project's development.

Submitting Changes

For local dashboard setup, see apps/dashboard/README.md.

To contribute code changes, follow these steps:

  1. Fork the repository and create a new branch for your changes.
  2. Ensure that your code follows the project's coding conventions and style guide.
  3. Run pnpm verify — formatting, lint, doc references and type checks. It needs
    no database and takes seconds. pnpm verify:test runs the tests for the
    packages your diff touches; those do need a local libSQL server.
  4. Make commits with clear and descriptive messages. Each commit should have a single logical purpose.
  5. Push your branch to your forked repository.
  6. Open a pull request (PR) from your branch to the original repository's main branch.
  7. Provide a detailed description of your changes in the PR, including any related issues or feature requests.

A project maintainer will review your PR, provide feedback if necessary, and merge it once it meets the project's standards.

Coding Conventions

Please adhere to the existing coding conventions and style guide used in this project. Consistent coding styles improve code readability and maintainability. If you're unsure about any aspect of the coding conventions, feel free to ask for clarification in your PR.

Documentation

Improvements to documentation are always welcome. If you find any inaccuracies, missing information, or have suggestions for improving the documentation, you can contribute by submitting a PR with your changes. Make sure to clearly explain the purpose of the documentation update and provide relevant examples, if applicable.

SECURITY

Reporting Security Issues

The openstatus team takes security bugs in openstatus seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.

To report a security issue, please reach out to us via email at ping@openstatus or on Discord

Please do the following:

  • Do not run automated scanners on our infrastructure or dashboard. If you wish to do this, contact us and we will set up a sandbox for you.
  • Do not take advantage of the vulnerability or problem you have discovered, for example by downloading more data than necessary to demonstrate the vulnerability or deleting or modifying other people's data,
  • Do not reveal the problem to others until it has been resolved,
  • Do not use attacks on physical security, social engineering, distributed denial of service, spam or applications of third parties,
  • Do provide sufficient information to reproduce the problem, so we will be able to resolve it as quickly as possible. Usually, the IP address or the URL of the affected system and a description of the vulnerability will be sufficient, but complex vulnerabilities may require further explanation.

What we promise:

  • We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date,
  • If you have followed the instructions above, we will not take any legal action against you in regard to the report,
  • We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission,
  • We will keep you informed of the progress towards resolving the problem,
  • In the public information concerning the problem reported, we will give your name as the discoverer of the problem (unless you desire otherwise), and
  • We strive to resolve all problems as quickly as possible, and we would like to play an active role in the ultimate publication on the problem after it is resolved.

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#bun Browse bun catalog → #drizzle-orm Browse drizzle-orm catalog → #monitoring Browse monitoring catalog → #monitoring-as-code Browse monitoring-as-code catalog → #nextjs Browse nextjs catalog → #observability Browse observability catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →