uplink.yaml Reference

The parser denies unknown fields. ${ENV} references are expanded before YAML parsing; an unset variable is an error.

edge: edge.example.com
inspect: true

access_policies:
  staff:
    accounts: [a@example.com, b@example.com]
  office-or-token:
    any:
      - cidrs: [203.0.113.0/24]
      - token: ${TEAM_TOKEN}

firewall_rules:
  no-dotenv:
    block: { path: /.env }
  api-limit:
    rate_limit: { requests: 100, window_secs: 60, per: ip }
    match: { path: /api }
    monitor: true
  global-limit:
    rate_limit: { requests: 1000, window_secs: 60 }
    all_services: true

services:
  web:
    port: 3000
    access: public
  api:
    port: 8080
    access: password
    password: ${API_TOKEN}
    firewall: [no-dotenv, api-limit]

Top-level fields are edge, inspect, access_policies, firewall_rules, and services.

Service fields are port, access, password, share, edge, and firewall.