> For the complete documentation index, see [llms.txt](https://traffic-hunter.gitbook.io/titan/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://traffic-hunter.gitbook.io/titan/start/quickstart.md).

# Quickstart

Run a Titan server and verify it from the monitoring API.

## Requirements

* JDK 21 or newer
* A Titan `0.8.4` standalone server JAR from GitHub Releases

## 1. Create the environment

Create `titan-env.yml` next to the server JAR:

```yaml
titan:
  monitor:
    enabled: true
    host: 127.0.0.1
    port: 7777
  servers:
    - name: stomp-dispatch
      protocol: stomp
      host: 0.0.0.0
      port: 61613
      transport-options:
        reuse-address: "true"
        child-tcp-no-delay: "true"
      protocol-options:
        supported-versions: "1.2"
        max-frame-length: "1048576"
        heartbeat-x: "1000"
        heartbeat-y: "1000"
        fanout-mode: "virtual"
```

## 2. Start Titan

```bash
java -Dtitan.environment.path=./titan-env.yml \
  -jar titan-server-0.8.4.jar
```

Titan now accepts STOMP connections on `61613` and exposes its local monitor on `127.0.0.1:7777`.

### Docker

The repository includes a container-ready configuration. Build the image and start Titan with:

```bash
docker compose up --build
```

To run a released image as a standalone container with its default configuration:

```bash
docker run --rm --name titan \
  -p 61613:61613 \
  -p 127.0.0.1:7777:7777 \
  ghcr.io/traffic-hunter/titan:latest
```

Mount your own configuration when the defaults are not sufficient:

```bash
docker run --rm --name titan \
  -p 61613:61613 \
  -p 127.0.0.1:7777:7777 \
  -v "$PWD/titan-env.yml:/etc/titan/titan-env.yml:ro" \
  ghcr.io/traffic-hunter/titan:latest
```

Server and monitor bind addresses in the mounted configuration must use `0.0.0.0` when their ports need to be published by Docker.

Run the containerized terminal dashboard against the Compose server:

```bash
docker compose --profile tools run --rm titan-cli
```

Without Compose, attach the server and CLI containers to the same network:

```bash
docker network create titan
docker run --detach --name titan --network titan \
  -p 61613:61613 -p 127.0.0.1:7777:7777 \
  ghcr.io/traffic-hunter/titan:latest
docker run --rm -it --network titan \
  ghcr.io/traffic-hunter/titan-cli:latest \
  --addr http://titan:7777
```

## 3. Verify the node

```bash
curl http://localhost:7777/titan/monitor/health
curl http://localhost:7777/titan/monitor/snapshot
```

## 4. Send your first message

Choose the client path that matches your application:

* [Native STOMP client](/titan/build/client.md) for direct lifecycle control
* [Spring Boot](/titan/build/spring-client.md) for `TitanTemplate` and `@TitanListener`

Use `/notifications` in both the subscriber and publisher examples to see a message travel through the same destination.

## Next steps

* Learn [how Titan works](/titan/learn/how-titan-works.md).
* Understand [dispatch routing](/titan/learn/destinations.md).
* Add terminal visibility with [Monitoring and CLI](/titan/operate/monitoring.md).
* Configure [WebSocket or TLS transport](/titan/reference/configuration.md).