Files
openchamber/packages/web/server/lib/tunnels/DOCUMENTATION.md
T
Bohdan Triapitsyn 00a7807168 feat: add Ngrok tunnel provider (#1415)
Adds Ngrok quick tunnel support
Adds desktop tunnel docs across locales
Improves tunnel settings provider and TTL labels
2026-05-25 18:00:03 +03:00

1.1 KiB

Tunnels Module Documentation

Purpose

This module contains tunnel provider orchestration for OpenChamber, including provider registry/service wiring, managed remote token config lifecycle, and tunnel HTTP route registration.

Entrypoints and structure

  • packages/web/server/lib/tunnels/index.js: tunnel service orchestration.
  • packages/web/server/lib/tunnels/registry.js: provider registry.
  • packages/web/server/lib/tunnels/managed-config.js: managed remote tunnel token/preset persistence runtime.
  • packages/web/server/lib/tunnels/routes.js: tunnel API route registration and request orchestration runtime.
  • packages/web/server/lib/tunnels/types.js: tunnel constants, normalization, and shared type helpers.
  • packages/web/server/lib/tunnels/providers/cloudflare.js: Cloudflare tunnel provider implementation.
  • packages/web/server/lib/tunnels/providers/ngrok.js: Ngrok quick tunnel provider implementation.

Public exports (routes.js)

  • createTunnelRoutesRuntime(dependencies): creates tunnel routes runtime and helpers.
  • Returned API:
    • registerRoutes(app)
    • startTunnelWithNormalizedRequest(request)