> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superlog.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Self-Host Superlog: Complete Stack on Your Infrastructure

> Run Superlog on your own infrastructure using Docker Compose. All services — API, proxy, worker, and databases — start with a single command.

The Superlog Community edition is a complete, self-contained observability stack you can run on any machine with Docker installed. A single `docker compose up` command starts the databases; a single `pnpm dev` command starts the web app, API, OTLP ingest proxy, and background workers. All of your telemetry stays on your own infrastructure.

## Prerequisites

Before you begin, make sure you have the following installed:

* **Node.js 20+** — [nodejs.org](https://nodejs.org)
* **pnpm 9+** — `npm install -g pnpm`
* **Docker** (with the Compose plugin) — [docker.com](https://www.docker.com/get-started)

## Local service endpoints

Once running, the stack exposes three local endpoints:

| Service     | URL                     | Purpose                                         |
| ----------- | ----------------------- | ----------------------------------------------- |
| Web app     | `http://localhost:5173` | Dashboard, incidents, agent runs                |
| API         | `http://localhost:4100` | REST API used by the web app                    |
| OTLP intake | `http://localhost:4101` | Receive traces, logs, and metrics from your app |

Point your application's OTLP exporter at `http://localhost:4101` to start sending data.

## Setup

<Steps>
  <Step title="Clone the repository">
    Clone the Superlog monorepo from GitHub:

    ```bash theme={null}
    git clone https://github.com/superloglabs/superlog
    cd superlog
    ```
  </Step>

  <Step title="Install dependencies">
    Superlog uses [pnpm workspaces](https://pnpm.io/workspaces). Install all dependencies from the repo root:

    ```bash theme={null}
    pnpm install
    ```
  </Step>

  <Step title="Start the databases">
    Use Docker Compose to start the database services in the background. The compose file also starts the OpenTelemetry Collector, which receives OTLP data and writes it to storage.

    ```bash theme={null}
    docker compose up -d
    ```

    Wait for all containers to report as healthy before continuing. You can check their status with:

    ```bash theme={null}
    docker compose ps
    ```
  </Step>

  <Step title="Run database migrations">
    Apply the schema migrations to the database:

    ```bash theme={null}
    pnpm --filter @superlog/db db:migrate
    ```

    You only need to run this once on a fresh install, and again after pulling commits that include new migrations.
  </Step>

  <Step title="Start all services">
    Start the web app, API, ingest proxy, and background workers together with a single command from the repo root:

    ```bash theme={null}
    pnpm dev
    ```

    Open your browser at `http://localhost:5173`. The onboarding wizard will guide you through creating your first organisation and API key.
  </Step>
</Steps>

## Editions

<Note>
  The Community edition you are running is **fully open-source** under the [Apache License 2.0](https://github.com/superloglabs/superlog/blob/main/LICENSE.md). You are free to use, modify, and distribute it for any purpose — including commercial use — without paying anything.

  The default community agent runner records a local incident summary for every detected incident. To enable AI-powered root-cause analysis and automated fix PRs, connect a GitHub integration — see the tip below.
</Note>

<Info>
  **Superlog Cloud** is available at [superlog.sh](https://superlog.sh) with a free tier and pay-as-you-go plans. Cloud provides managed infrastructure, automatic upgrades, and the full AI agent experience without any ops overhead.
</Info>

<Tip>
  To enable AI agent investigations and automated fix PRs, connect Superlog to your GitHub repositories. See the [GitHub Integration guide](/integrations/github) for step-by-step instructions.
</Tip>