2026-03-31 18:47:00 +03:00
|
|
|
# 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.
|
2026-06-05 15:01:22 +03:00
|
|
|
- `packages/web/server/lib/tunnels/executable-search.js`: cross-platform executable discovery, including Windows Store app aliases.
|
2026-03-31 18:47:00 +03:00
|
|
|
- `packages/web/server/lib/tunnels/registry.js`: provider registry.
|
|
|
|
|
- `packages/web/server/lib/tunnels/managed-config.js`: managed remote tunnel token/preset persistence runtime.
|
2026-06-05 15:01:22 +03:00
|
|
|
- `packages/web/server/lib/tunnels/install-help.js`: provider/platform install command metadata for missing tunnel dependencies.
|
2026-03-31 18:47:00 +03:00
|
|
|
- `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.
|
2026-05-25 18:00:03 +03:00
|
|
|
- `packages/web/server/lib/tunnels/providers/ngrok.js`: Ngrok quick tunnel provider implementation.
|
2026-03-31 18:47:00 +03:00
|
|
|
|
|
|
|
|
## Public exports (routes.js)
|
|
|
|
|
- `createTunnelRoutesRuntime(dependencies)`: creates tunnel routes runtime and helpers.
|
|
|
|
|
- Returned API:
|
|
|
|
|
- `registerRoutes(app)`
|
|
|
|
|
- `startTunnelWithNormalizedRequest(request)`
|