Skip to content

Liferay Tunnel Documentation

Welcome to the Liferay Tunnel documentation! This is the central hub for learning how to use, deploy, and contribute to lfr-tunnel.

📖 Developer & Client Guides

  • Getting Started Guide: Learn the basic concepts, registration flow, and how to start your first tunnel.
  • Client Configuration File: Complete key reference for ~/.lfr-tunnel/config.yaml — every setting, its flag and environment equivalents, which of the three wins, and why server_url: is not the same as -pin.
  • Liferay SE Guide: Team-specific instructions for Liferay Sales Engineering (LDM setup, codesigning path exclusions, dynamic configurations).
  • MCP Guide: Learn how to set up the Model Context Protocol (MCP) server to use the tunnel with AI assistants.
  • Exposing Any Local HTTP Service: Addendum — the tunnel does not inspect what is listening on the port it publishes, so a client extension in dev mode, a Node service or any other local HTTP server works with -ports. Naming a port switches the Liferay auto-discovery off.

⚙️ Server & Operator Deployment Guides

All operator deployment and configuration resources are organized under the docs/server/ directory: - Control Plane Setup: Central VPS installation guide, including systemd service configurations, Nginx reverse proxy setups, Let's Encrypt certificates, postfix SMTP relaying, and security access lists. - Edge Node Scaling: Setting up regional Edge Nodes and configuring real-time edge lease kicks and state updates via WebSockets. - AWS EC2 Provisioning Guide: AWS-specific supplement covering EC2 instance/AMI choice, security groups, key pairs, and Elastic IPs for either the control plane or edge nodes. - SSO/OIDC Cloud Guide: Integrating gateways with Single Sign-On (SSO) providers (Keycloak, Azure AD/Entra, AWS, Google Cloud).

🛡️ Architecture & Security Compliance

  • System Architecture Guide: Deep dive into the unified network routing sequence, HTTP/WebSocket multiplexing, database tables, passwordless magic links, and OIDC auth flows.
  • InfoSec & Trust Guide: Trust verification, binary codesigning (macOS/Windows), corporate network compliance, path exclusions, and gateway administrative security controls.

🤝 Contributing & Development

  • Contributing Guide: General contribution rules, git branching conventions, code style checks, and release checklists.
  • Testing Protocol: Detailed instructions for running automated unit/E2E tests locally and manual exploratory test scenarios.

Last Updated: 2026-09-19 | Last Reviewed: 2026-09-19