# OpenLIT local sandbox

> Free Docker Compose sandbox for OpenLIT. Create your own API key in the local UI. No credit card and no sales form.

- HTML: https://openlit.io/sandbox
- Install docs: https://docs.openlit.io/latest/openlit/installation
- Repository: https://github.com/openlit/openlit
- CLI: https://docs.openlit.io/latest/cli/installation

The sandbox is the self-hosted OpenLIT stack running on your machine. It is the test environment agents and developers can start immediately. OpenLIT Cloud is not generally available, so there is no shared hosted tenant to sign into on openlit.io.

## Start it

Clone the repository and start Compose from the repository root:

```shell
git clone https://github.com/openlit/openlit.git
cd openlit
docker compose up -d
```

The OpenLIT container serves the UI on port 3000 and the built-in OTLP receiver on 4317 (gRPC) and 4318 (HTTP). ClickHouse is included for traces, metrics, and logs. You need Docker and Docker Compose. On Kubernetes, the same stack is installed with `helm install openlit openlit/openlit` after adding the Helm repo at https://openlit.github.io/helm/.

## API keys

Open http://localhost:3000, then go to Settings → API Keys → Create API Key. Name the key and store it. Send it as `Authorization: Bearer`. Community edition keys can call the API-key endpoints. The scope names an agent should request are `ingest`, `telemetry`, `prompts`, `vault`, `rule_engine`, `evaluation`, `chat`, `controller`, and `db_config`, published at https://openlit.io/openapi.json.

## Instrument

Point an SDK at the sandbox with `openlit.init()`, or point the CLI at the receiver:

```shell
brew install openlit/openlit/openlit
openlit configure --endpoint http://127.0.0.1:4318
```

The Homebrew formula is https://github.com/openlit/homebrew-openlit/blob/main/Formula/openlit.rb.

This sandbox is free under Apache 2.0. Usage limits are whatever your machine can store. Prompts and traces stay on your computer.