liaison

README

Liaison

Connector-powered access to devices and apps behind NAT

English | 简体中文 | 日本語 | 한국어 | Español | Français | Deutsch

Jellyfin (Stream Home Movies Anywhere)	OpenClaw (Use Home AI Anywhere)

Quick Start • Introduction • Documentation • Contributing

---

Introduction

Liaison is an enterprise-grade application access solution that can be enabled or disabled at any time, without exposing ports on your LAN or home network. It provides a complete feature set: automatic app discovery on connected devices, real-time traffic metrics, and secure TLS-encrypted transport.

This project addresses:

• Private network access — Reach devices and services behind NAT from the public internet with minimal setup
• Multi-device management — Manage devices across locations with Linux/macOS/Windows support
• Secure connectivity — TLS-encrypted transport without exposing ports on your LAN or home network
• Per-entry firewall — Source-IP CIDR allowlist on each TCP or HTTP entry, enforced at connection accept
• Traffic monitoring — Real-time device status and traffic metrics for operations and capacity planning
• Application proxy — TCP, HTTP/HTTPS, WebSocket and other protocols
• API automation — Personal Access Tokens (PAT) for CLI/scripts with a browser-mediated sign-in flow at /cli-auth

Use cases:

💼 Remote Work & Dev	🧑‍💻 Personal Studio	🏠 Home Network / NAS	🌐 Multi-datacenter / Multi-region	⚡ Edge & Ops
Connect office and home devices for remote development and debugging	Securely connect workstations and private environments with unified device management	Access home NAS and smart-home services from the public internet	Unified connectivity for servers and applications across regions and datacenters	Connect and monitor edge applications with remote health and traffic checks

---

Quick Start

Pick one of the two server deployment options, then install a connector.

Install Server — Option 1: Binary + systemd

1. Download

wget https://github.com/liaisonio/liaison/releases/download/v1.5.0/liaison-1.5.0-linux-amd64.tar.gz
tar -xzf liaison-1.5.0-linux-amd64.tar.gz
cd liaison-1.5.0-linux-amd64

2. Run install script

sudo ./install.sh

You will be prompted for a public IP or domain; if none is entered within 30 seconds, the detected public IP is used.

3. Open Web console

Visit https://your-public-ip to access the Web console.

Tip: Default admin credentials are shown in the install script output or config.

Install Server — Option 2: Docker Compose

Requires Docker 20.10+ with the docker compose plugin. The bundle ships liaison + frontier as two containers; images are pre-built — no registry or source checkout needed.

wget https://github.com/liaisonio/liaison/releases/download/v1.5.0/liaison-1.5.0-docker-amd64.tar.gz
tar -xzf liaison-1.5.0-docker-amd64.tar.gz
cd liaison-1.5.0-docker-amd64
./load.sh

load.sh auto-detects your public IP (with a 30-second countdown prompt), loads the bundled images, starts the stack, and prints the one-time admin password when liaison is ready. Save the password and open https://<public-ip> to log in.

Data (data/ SQLite), TLS certs (certs/), and logs (logs/) are bind-mounted next to docker-compose.yaml for persistence. See deploy/docker/README.md for source builds, upgrade / reset / reverse-proxy / custom-cert recipes.

Install Connector

Create a new connector in the Web console, copy the install command for your platform from the UI, and run it on the target device. The connector will appear in the console automatically.

---

System Requirements

Component	Requirements
Server	Linux (Ubuntu 20.04+ or CentOS 7+ recommended)
Connector	Linux / macOS / Windows (x86_64 and ARM64)
Browser	Chrome 90+, Firefox 88+, Safari 14+, Edge 90+

---

Architecture

Liaison uses a centralized architecture with Frontier managing all connectors.

Components

• Liaison — Web UI and API, plus application entry points
• Frontier — Connector gateway that handles connector connections and traffic routing
• Edge — Connector client on target devices

---

Feature Showcase

Feature	Screenshot
Device Management
Application Management
Proxy Configuration
Edge Management

---

Documentation

• Business flow
• API

---

Contributing

Contributions are welcome.

• Report a bug
• Suggest a feature
• Open a PR
• Improve docs

1. Fork the repo
2. Create a branch (git checkout -b feature/AmazingFeature)
3. Commit (git commit -m 'Add some AmazingFeature')
4. Push (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

License

Apache License 2.0.

---

If this project helps you, please give it a ⭐ Star!

Made with ❤️ by Liaison Contributors

GitHub • Issues • Discussions