Zero to Running in 30 Seconds

Installation & Quickstart Guide

Deploy ExoRoute on your local machine or server. Zero Docker overhead, zero external database daemon, just a single standalone native binary.

1

Install Prebuilt Binary

The installer script validates cryptographic checksums via Sigstore Cosign before placing the binary directly into your system PATH.

curl -fsSL https://raw.githubusercontent.com/nghiaomg/ExoRoute/main/install.sh | sh
2

Launch the Gateway

Start the gateway daemon directly in your terminal. The default action is `serve`:

exoroute

On first launch, ExoRoute automatically:

  • Creates the application directory and secure configuration file .env.
  • Generates a temporary Admin Password and prints it to the terminal.
  • Generates and stores the hardware-bound encryption key EXOROUTE_MASTER_KEY.
  • Initializes the embedded LMDB database and launches the Dashboard at http://127.0.0.1:8686.
Security Notice:

On a fresh installation, the dashboard enforces changing the initial admin password before traffic is routed. Complete this step immediately after login.

3

Configure Provider & Create Gateway API Key

1. Add Upstream Provider

Navigate to the Providers menu in the Dashboard. Select OpenAI, Anthropic, OpenRouter, or local Ollama and enter your upstream API key.

2. Generate Gateway API Key

Navigate to the API Keys menu to create local authentication keys (formatted as exo-live-...) for client applications.

4

Send Your First Request

Point your favorite client SDK base URL to `http://127.0.0.1:8686/v1` and authenticate with your gateway key:

curl http://127.0.0.1:8686/v1/chat/completions \
  -H "Authorization: Bearer exo-live-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello ExoRoute!"}],
    "stream": true
  }'