Skip to content

Quick start

Tyr can be running in about 60 seconds. Pick the option that matches your platform.

This pulls pre-built images from GHCR. No git clone required.

Terminal window
curl -sSL https://raw.githubusercontent.com/terranchi/tyr/main/docker-compose.yml \
| docker compose -f - up

What just happened:

  • PostgreSQL 17 started on port 5432.
  • tyr-server started and pre-seeded a bootstrap enrollment token (tyr-quickstart-token).
  • tyr-agent started with host-privileged networking, mounted /sys/kernel/debug and /sys/fs/bpf, attached eBPF programs to your host kernel, and registered with the server.

Open http://localhost:7701, complete the one-time setup wizard (creates the first admin user), and you should see the docker-host agent online and events streaming in.

Option 2 — Native Linux install

If you want the agent running against your real host kernel (no Docker indirection):

Terminal window
curl -sSL https://raw.githubusercontent.com/terranchi/tyr/main/scripts/install.sh | bash

The script offers an interactive menu:

  • Install the agent (requires Linux + kernel 5.15+)
  • Install the CLI only
  • Install both

It downloads the correct tarball for your architecture from the Releases page, drops binaries into /usr/local/bin, and (for the agent) installs a tyr-agent.service systemd unit.

Non-interactive:

Terminal window
curl -sSL https://raw.githubusercontent.com/terranchi/tyr/main/scripts/install.sh \
| bash -s -- --component both \
--server https://your-server:7700 \
--token <enrollment-token> \
--name my-laptop

See the Linux systemd guide for ongoing operation.

Option 3 — Build from source

  1. Install prerequisites:

    Terminal window
    # macOS
    brew install rustup protobuf pnpm
    # Ubuntu/Debian
    sudo apt install rustup protobuf-compiler
    curl -fsSL https://get.pnpm.io/install.sh | sh -
  2. Clone and build:

    Terminal window
    git clone https://github.com/terranchi/tyr.git
    cd tyr
    cargo build --release # builds tyr, tyr-server, tyrd
    cd web && pnpm install && pnpm build && cd ..
  3. Run the dev stack (builds images from source):

    Terminal window
    docker compose -f deploy/docker-compose.dev.yml up

Next steps