How thinktecture/relayserver works
Project type and its purpose
• A distributed, modular reverse-proxy solution (library-first) for securely relaying HTTPS requests from arbitrary clients (web, mobile, native) to on-premises applications behind firewalls.
• Consists of a public RelayServer, on-prem RelayServer Connector(s), a Management API, persistence layer, pluggable transport protocols, and supporting tools/containers.
Main components
• Clients
• Any HTTP-capable app (browser, mobile, IoT) sending REST-style HTTPS requests.
• RelayServer (public)
• HTTP(S) reverse-proxy endpoints (Discovery, Acknowledge, BodyContent, dynamic routing).
• Modular “Server” libraries:
– Thinktecture.Relay.Server.* (Endpoints, Middleware, Transport, Services)
– Thinktecture.Relay.Server.Abstractions (contracts for interception, persistence, transport)
– Thinktecture.Relay.Server.Persistence.EntityFrameworkCore.* (PostgreSQL, SQL Server)
– Protocol plugins (SignalR, RabbitMQ) under src/Thinktecture.Relay.Server.Protocols.*
– Management API (Tenant CRUD) under src/Thinktecture.Relay.Server.Management
• RelayServer Connector (on-prem)
• Long‐running .NET Core component or Windows Service embedding libraries:
– Thinktecture.Relay.Connector.* (core connector logic, DI, authentication, targets)
– Protocol adapters under Thinktecture.Relay.Connector.Protocols.* (SignalR)
• On-prem backend applications
• Your existing Web/API services receiving forwarded requests from the connector over HTTP on localhost
• Database
• PostgreSQL or SQL Server for storing tenants, connections, request statistics
• External services (optional)
• RabbitMQ broker if using the RabbitMQ transport protocol
• Keycloak or other OAuth/OpenID provider (example in Docker setup)
Relationships & data flows
1. Client → RelayServer (HTTPS)
2. RelayServer → (Discovery & Acknowledge) → Connector (persistent channel via SignalR or RabbitMQ)
3. RelayServer dispatches HTTP request contexts across that channel
4. Connector receives request context, forwards to local on-prem backend over HTTP
5. Backend response flows back: Connector → RelayServer → Client
6. Management UI/CLI → Management API (HTTP) → Database (tenant provisioning)
7. RelayServer reads config from Database on startup or per request (via EF Core)
8. Statistics / auditing written to Database
Architectural patterns & principles
• Modular plug-in architecture: transports, persistence stores, interceptors are exchangeable libraries
• Dependency Injection throughout (see “DependencyInjection” folders in each project)
• Microservices/Containers: separate Docker containers for RelayServer, Connector, Management API
• Layered design: Abstractions → Implementation → Host (Docker)
What
a. Components (use rounded rectangles or containers):
– Client apps
– RelayServer HTTP Interface
– Discovery / Acknowledge / BodyContent Endpoints
– Transport Coordinator (SignalR / RabbitMQ plugin modules)
– Persistence Service (EF Core + DB)
– Management API (Tenant endpoints)
– RelayServer Connector (SignalR/RabbitMQ client library)
– On-prem Backend API
– RabbitMQ broker (if used)
– Blue for “Server” modules
– Green for “Connector” modules
– Orange for “Database / Broker”
– Grey for “Client”
d. Annotations:
– Indicate persistence choices (PostgreSQL vs SQL Server)
– Note pluggable points (e.g., “swap in RabbitMQ transport” callout)
– Highlight interceptors (ForwardedHeader, DemoRequestInterceptor)
Detailed breakdown for the RelayServer container
• Layer 1: HTTP Interface
– DiscoveryDocumentEndpoint
– AcknowledgeEndpoint
– BodyContentEndpoint
• Layer 2: Middleware & Interceptors
– RelayMiddleware, ForwardedHeaderInterceptor
• Layer 3: Dispatch & Transport
– RequestCoordinator / ResponseDispatcher
– ConnectorRegistry → appropriate IConnectorTransportFactory (SignalR or RabbitMQ)
• Layer 4: Persistence & Statistics
– TenantService, RequestService, StatisticsService using RelayDbContext
• Layer 5: Management API
– Get/Post/Put/Delete Tenant Endpoints
Detailed breakdown for the Connector container
• ConnectorBuilderExtensions → configures:
– IAccessTokenProvider
– Target options (Echo, Ping, WebTarget)
• HubConnectionFactory → persistent SignalR connection
• AcknowledgeTransport & ResponseTransport classes
• ClientRequestHandler & ClientRequestWorker → forward to local HTTP endpoint