Быстрый старт

Ниже — минимальный практический сценарий: один Beacon/bootstrap relay, один sidecar-сервис и клиент.

Для production не останавливайтесь на одном Beacon/relay. Эта схема нужна, чтобы понять механику.

На машине с `knotroute` выполните `knotroute network create` и сохраните `kn_...`. Запустите `knotroute-beacon` или Docker image и откройте relay TCP-порт `7447`. Добавьте `knotroute-sidecar` рядом с приложением и укажите target вроде `app:8080`. Передайте клиенту Network ID и Beacon URL либо onboarding profile из Control. Возьмите service address из sidecar logs/Control и откройте его через KnotRoute client.

1. Создать сеть

knotroute network create

Результат:

kn_...

Используйте этот ID во всех компонентах одной сети.

2. Beacon через Docker

services:
  beacon:
    image: ghcr.io/localzet/knotroute-beacon:latest
    restart: unless-stopped
    ports:
      - "8080:8080"
      - "7447:7447"
    volumes:
      - beacon-data:/data
    environment:
      KNOTROUTE_NETWORK_ID: "kn_..."
      KNOTROUTE_BEACON_LISTEN: "0.0.0.0:8080"
      KNOTROUTE_BEACON_RELAY: "true"
      KNOTROUTE_BEACON_RELAY_LISTEN: "0.0.0.0:7447"
      KNOTROUTE_BEACON_RELAY_ADVERTISE: "relay.example.net:7447"

volumes:
  beacon-data:

Для production Beacon HTTP лучше отдавать через HTTPS reverse proxy, а 7447/tcp оставить отдельным raw TCP endpoint.

3. Sidecar рядом с приложением

services:
  app:
    image: nginx:alpine
    networks: [private]

  knotroute:
    image: ghcr.io/localzet/knotroute-sidecar:latest
    restart: unless-stopped
    networks: [private]
    volumes:
      - knotroute-data:/data
    environment:
      KNOTROUTE_NETWORK_ID: "kn_..."
      KNOTROUTE_BEACONS: "https://beacon.example.net"
      KNOTROUTE_SERVICE_NAME: "web"
      KNOTROUTE_SERVICE_TARGET: "app:80"

networks:
  private:

volumes:
  knotroute-data:

Посмотрите logs:

docker compose logs -f knotroute

Sidecar печатает published service address.

4. Клиент

На Windows используйте desktop app; на Android — Android client; на Linux/macOS можно запустить CLI node и направить браузер/приложение на локальный HTTP/SOCKS proxy.

Клиенту нужны как минимум:

Network ID: kn_...
Beacon:     https://beacon.example.net

5. Проверка

Проверьте не только /healthz, а реальный end-to-end путь с другой машины:

client → discovery → circuit → directory → rendezvous → sidecar → app

Если .knot не открывается, используйте пошаговый troubleshooting.

Исходник