Tera Router

Installation

Run the Tera Router API server and dashboard locally.

Prerequisites

  • Go 1.26+ (server)
  • Node.js 22+ and pnpm (dashboard & docs)
  • No other external dependencies — the database uses SQLite (the terarouter.db file)

Run the API server

cd apps/server

# prepare a minimal .env
cat > .env <<'EOF'
MACHINE_ID=1
APP_SECRET=change-to-a-long-secret
[email protected]
ADMIN_PASSWORD=admin123
EOF

make run

The server will:

  1. Run SQLite migrations (MIGRATE_ON_BOOT, enabled by default).
  2. Seed initial data — roles, the admin user from ADMIN_EMAIL/ADMIN_PASSWORD, the Default plan.
  3. Open the gateway and dashboard API on PORT (default 8080).

Development mode

With ENV=development, the server automatically seeds a sample "Dev" key. Get its plaintext via make seed/dev — the plaintext is printed only once.

Run the dashboard

# from the monorepo root
pnpm install

cd apps/web-ui
cp .env.example .env   # VITE_API_URL points to http://localhost:8080
pnpm dev

Open http://localhost:5173, then sign in with the ADMIN_EMAIL and ADMIN_PASSWORD you set earlier.

Ports and services

ServiceURLNotes
API serverhttp://localhost:8080Gateway (/v1/*) + dashboard API
Dashboard UIhttp://localhost:5173Vite dev server (apps/web-ui)
Docshttp://localhost:3001This site (apps/docs)

Seeding the first key (without the dashboard)

cd apps/server
make seed/dev   # prints the sample key's plaintext, once only

Store the plaintext safely — only the hash lives in the database.

Next steps

On this page

PrerequisitesRun the API serverRun the dashboardPorts and servicesSeeding the first key (without the dashboard)Next steps