Skip to content

singchia/liaison

Repository files navigation

Liaison

English | 中文

Go Go Report Card License Tech Version

Connector-powered access to devices and apps behind NAT

Dashboard

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

Quick StartIntroductionDocumentationContributing


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
  • Traffic monitoring — Real-time device status and traffic metrics for operations and capacity planning
  • Application proxy — TCP, HTTP/HTTPS, WebSocket and other protocols

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

Install Server

1. Download

wget https://github.com/singchia/liaison/releases/download/v1.3.1/liaison-v1.3.1-linux-amd64.tar.gz
tar -xzf liaison-v1.3.1-linux-amd64.tar.gz
cd liaison-v1.3.1-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 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 Device
Application Management Application
Proxy Configuration Proxy
Edge Management Edge

Documentation


Contributing

Contributions are welcome.

  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

GitHubIssuesDiscussions

About

Liaison uses connectors to access devices and apps behind NAT. Connect home, office, and data center environments with stable, secure connectivity, without exposing LAN or home network ports.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors