Skip to Content
🚀 Wiredoor v1.7.3 now available - Ready to expose your private services? Get Started →

Configure Wiredoor Services

A Wiredoor service connects a public address to a backend that the selected node can reach. Choose HTTP for web applications and APIs, TCP for connection-oriented protocols, or UDP for datagram-based services.

Understand Service Routing

Every service belongs to a Local, Client, or Gateway Node. The node determines which backend addresses Wiredoor can use.

Node typeDefault backend reach
Local NodeServices reachable directly from Wiredoor Server
Client NodeA service running on the same machine as the Wiredoor CLI
Gateway NodeAn address or service name inside an approved private subnet

Wiredoor validates backend reachability before creating supported service routes. A connected node does not guarantee that the backend process is listening on the selected port.

Configure HTTP Services

An HTTP service is selected by domain and path. NGINX terminates public HTTPS and forwards the request to an HTTP or HTTPS backend.

SettingPurpose
NameIdentifies the service in Wiredoor
DomainSelects the public hostname
PathSelects a route such as /, /api, or /dashboard
Backend protocolUses http or https when connecting to the private service
Backend hostSelects a target for Local or Gateway Nodes
Backend portSelects the port where the private HTTP service listens
AuthenticationRequires OAuth2 when enabled on both the domain and service
Allowed IPsLimits access to the listed IP addresses or CIDR networks

Each domain and path combination must be unique. Use the root path / when the application should handle the entire domain.

For a Client Node, Wiredoor sends traffic to that node and the selected port. For a Gateway Node, provide a backend host or service name that the gateway can resolve and reach. Use backend protocol https only when the private backend itself expects HTTPS.

Public HTTPS termination does not automatically secure the connection from the node to the backend. Select an HTTPS backend when that private connection also requires TLS.

Configure TCP and UDP Services

TCP and UDP services are selected by public port instead of an HTTP path.

SettingPurpose
ProtocolSelects tcp or udp
Backend hostSelects a target for Local or Gateway Nodes
Backend portSelects the private service port
Public portUses an available configured range or additional port
TLSOptionally terminates TLS for a TCP service
Allowed IPsPermits only the listed IP addresses or CIDR networks
Blocked IPsDenies the listed IP addresses or CIDR networks

The Wiredoor Server must publish the assigned public port with the same protocol. The host or cloud firewall must also permit that port. Configure the available range and additional ports in the Wiredoor server configuration.

UDP services do not perform the same backend connection check as TCP services. Verify UDP traffic with a client that understands the real application protocol.

Control Service Availability

Services can be enabled, disabled, assigned a TTL, or deleted.

  • Disabling a service removes its active NGINX route but keeps the service definition.
  • Enabling a service rebuilds the route.
  • A TTL automatically disables the service after a duration such as 30m, 2h, or 1d.
  • Deleting a service removes its generated route and stored definition.
  • Deleting a remote node also deletes the services that belong to it.

The built-in Wiredoor_APP HTTP service on the Local Node cannot be deleted.

Use the Wiredoor CLI command reference for complete enable, disable, and exposure command syntax.

Choose Access Controls

Use the control that matches the service and audience:

ControlHTTPTCPUDPUse when
OAuth2YesNoNoUsers should authenticate through an identity provider
Allowed IPsYesYesYesOnly known client addresses or networks should connect
Blocked IPsNoYesYesSpecific TCP or UDP sources must be denied
Application authYesYesYesThe backend protocol provides its own authentication

IP rules use the client address visible to NGINX. A proxy or NAT device can replace the original address, so confirm the observed value in access logs before relying on an allow list.

See Wiredoor OAuth2 and IP restrictions for configuration and safe verification.

Verify a Service

After creating or changing a service:

  1. Confirm that the selected node is connected.
  2. Confirm that the backend is reachable from that node.
  3. Confirm that the required domain or public port reaches Wiredoor Server.
  4. Test from an intended client.
  5. Test from a client that should be denied when access controls are enabled.

Use the Wiredoor quickstart for a complete HTTP example. See Wiredoor troubleshooting when the public route exists but the backend does not respond.

Last updated on