How faulpeltz/dertunnel works
Main Components
A. Server-side Components:
• DNS Server (src/server/dns-server.ts)
• ACME Client (src/server/acme.ts)
• API Server (src/server/api-server.ts)
• Authentication System (src/server/auth.ts)
• Tunnel Dispatcher (src/server/dispatcher.ts)
• Admin UI Server
B. Client-side Components:
• CLI Interface (src/client/cli.ts)
• Tunnel Client (src/client/client.ts)
• Protocol Handlers (src/client/protocols.ts)
• Terminal UI (src/client/tui.ts)
C. Storage Components:
• Server Configuration Store (data/server.json)
• Client Tokens Store (data/clients.json)
• Certificate Storage (data/acme_tunnel.crt/key)
• DNS Layer | | Server Core | | Client Layer |
Connection Flows to Illustrate
a. DNS Flow:
External DNS → NS Record → DerTunnel DNS Server → A Record
b. Tunnel Flow:
Client App → Local TCP → Tunnel Client → TLS → Server → Public Endpoint
c. Admin Flow:
Browser → HTTPS → Admin UI → API Server → Authentication → Configuration
Key Elements to Highlight
• Blue: TLS connections
• Green: TCP connections
• Orange: DNS queries
• Purple: Admin/API connections
• Rectangles: Core services
• Hexagons: External interfaces
• Circles: Connection points
Important Details
a. Port Configurations:
• Main service port (service.<domain>)
• Public endpoint ports (demo-1234.<domain>)
• Admin UI port (admin.<domain>)
b. Security Layer:
• TLS termination points
• ACME certificate management flow
• Token-based authentication paths
Specific Implementation Notes
a. Certificate Management:
ACME Client → DNS-01 Challenge → DNS Server → Let's Encrypt → Wildcard Cert
b. Token Management:
Admin UI → Token Creation → Hash Storage → Client Authentication