> ## Documentation Index
> Fetch the complete documentation index at: https://cache-pot.thatdevguy.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure and access the Cache-Pot web dashboard UI

> Cache-Pot's embedded web dashboard runs on port 8080 by default. Configure its address or disable it entirely using --dashboard-addr.

Cache-Pot ships with a full-featured web dashboard served on `:8080` by default. There is nothing to install or build — the entire UI is compiled into the binary itself, so the console is available the moment you start the server.

## Accessing the dashboard

Open [http://localhost:8080](http://localhost:8080) in your browser after starting Cache-Pot. The server prints the dashboard URL to stdout on startup so you always know which address it is bound to:

```
cache-pot: dashboard on http://localhost:8080
```

## Dashboard configuration

A single flag controls the dashboard. All other behaviour is automatic.

<ParamField name="--dashboard-addr" type="string" default=":8080">
  Listen address for the web dashboard. Accepts any `host:port` value. Set to an empty string (`""`) to disable the dashboard entirely and free up the port.
</ParamField>

The equivalent environment variable is `CACHEPOT_DASHBOARD_ADDR`.

**Run the dashboard on a custom port:**

```bash theme={null}
cache-pot --dashboard-addr :9090
```

**Disable the dashboard entirely:**

<CodeGroup>
  ```bash Flag theme={null}
  cache-pot --dashboard-addr ""
  ```

  ```bash Environment variable theme={null}
  CACHEPOT_DASHBOARD_ADDR="" cache-pot
  ```
</CodeGroup>

## Dashboard pages

The dashboard is organised into eight pages, each focused on a specific area of the server.

* **Overview** — live stat tiles and rolling charts showing keys in memory, memory usage, commands per second, cache hit ratio, and server uptime.
* **Browser** — browse, create, edit, and delete keys visually. Supports flat and namespace-tree views, all data types, TTL editing, rename, and delete.
* **Workbench** — run RESP commands interactively in the browser, complete with command history and inline syntax hints.
* **Profiler** — a real-time stream of every command the server executes, equivalent to running `MONITOR` in the CLI.
* **Slowlog** — inspect commands that exceeded a configurable execution-time threshold and adjust the threshold without restarting.
* **Pub/Sub** — subscribe to channels or patterns and publish messages directly from the browser, all in real time.
* **Analysis** — memory usage breakdown by data type, key prefix, and TTL bucket, plus a largest-keys report.
* **Clients** — list every currently connected client with connection details, and kill individual connections.

<Note>
  The dashboard has **no authentication of its own**. If Cache-Pot is network-accessible, protect the dashboard port behind a firewall rule or a reverse proxy with its own auth before exposing it to untrusted networks.
</Note>

## Keyboard shortcuts

Keyboard navigation is built in. Press `g` followed by a letter to jump directly to any page without reaching for the mouse:

| Shortcut  | Page      |
| --------- | --------- |
| `g` + `o` | Overview  |
| `g` + `b` | Browser   |
| `g` + `w` | Workbench |
| `g` + `p` | Profiler  |
| `g` + `s` | Slowlog   |
| `g` + `u` | Pub/Sub   |
| `g` + `a` | Analysis  |
| `g` + `c` | Clients   |