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

# Dashboard

> Web interface for monitoring workflows

OpenWorkflow includes a built-in web dashboard for monitoring and debugging your
workflows. It lets you browse workflow runs, see which steps completed or
failed, inspect errors, and track the state of long-running workflows.

## Starting the Dashboard

<CodeGroup>
  ```bash npm theme={null}
  npx @openworkflow/cli dashboard
  ```

  ```bash pnpm theme={null}
  pnpx @openworkflow/cli dashboard
  ```

  ```bash bun theme={null}
  bunx @openworkflow/cli dashboard
  ```
</CodeGroup>

The dashboard starts on `http://localhost:3000` by default.

To use a custom port:

<CodeGroup>
  ```bash npm theme={null}
  npx @openworkflow/cli dashboard --port 4000
  ```

  ```bash pnpm theme={null}
  pnpx @openworkflow/cli dashboard --port 4000
  ```

  ```bash bun theme={null}
  bunx @openworkflow/cli dashboard --port 4000
  ```
</CodeGroup>

## Requirements

The dashboard requires:

1. A valid `openworkflow.config.ts` in your project
2. A running backend (PostgreSQL or SQLite)

The dashboard connects to the same backend as your workers. It shows data for
the namespace configured in your config file.

## Prometheus Metrics

The dashboard serves a Prometheus endpoint at `GET /metrics`. See the
[Prometheus guide](/docs/prometheus) for setup and alert examples.

<Note>
  The dashboard does not include built-in authentication. For production use,
  deploy it behind a VPN, private network, or reverse proxy with Basic Auth.
</Note>