{"id":44919129,"url":"https://github.com/singchia/liaison","last_synced_at":"2026-02-20T17:09:14.690Z","repository":{"id":332243523,"uuid":"1011933037","full_name":"singchia/liaison","owner":"singchia","description":"Instant, secure network reachability. 网络马上通达，Liaison 让你可以轻松连接分布在不同位置的设备与应用，无论你的设备在家、办公室或机房，都能通过 Liaison 建立稳定、安全的网络连接","archived":false,"fork":false,"pushed_at":"2026-02-15T16:47:04.000Z","size":6905,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-15T23:41:01.169Z","etag":null,"topics":["nat-traversal","proxy","sdp","zta","ztna"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/singchia.png","metadata":{"files":{"readme":"README.en.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-01T14:50:45.000Z","updated_at":"2026-02-12T04:11:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"0cac42fd-afc8-41e2-a1c4-a0d879367960","html_url":"https://github.com/singchia/liaison","commit_stats":null,"previous_names":["singchia/liaison"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/singchia/liaison","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singchia%2Fliaison","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singchia%2Fliaison/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singchia%2Fliaison/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singchia%2Fliaison/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/singchia","download_url":"https://codeload.github.com/singchia/liaison/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/singchia%2Fliaison/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29566677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T00:47:08.760Z","status":"online","status_checked_at":"2026-02-18T02:00:09.468Z","response_time":162,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nat-traversal","proxy","sdp","zta","ztna"],"created_at":"2026-02-18T03:03:30.672Z","updated_at":"2026-02-20T17:09:14.684Z","avatar_url":"https://github.com/singchia.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Liaison\n\n**Network connectivity made simple - Easily connect devices and applications across different locations**\n\n[![Go](https://github.com/singchia/liaison/actions/workflows/go.yml/badge.svg)](https://github.com/singchia/liaison/actions/workflows/go.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/singchia/liaison)](https://goreportcard.com/report/github.com/singchia/liaison)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![GitHub stars](https://img.shields.io/github/stars/singchia/liaison?style=social)](https://github.com/singchia/liaison/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/singchia/liaison?style=social)](https://github.com/singchia/liaison/network/members)\n\n[English](./README.en.md) | [中文](./README.md)\n\n![Dashboard](docs/pages/dashboard.png)\n\n[Quick Start](#-quick-start) • [Features](#-key-features) • [Use Cases](#-use-cases) • [Documentation](#-documentation) • [Contributing](#-contributing)\n\n\u003c/div\u003e\n\n---\n\n## ✨ Key Features\n\n\u003cdiv align=\"center\"\u003e\n\n| 🛡️ **Secure \u0026 Reliable** | 🚀 **Easy to Use** | 🌐 **Cross-Platform** | 🔍 **Auto Discovery** |\n|:---:|:---:|:---:|:---:|\n| TLS encryption for secure connections\u003cbr/\u003eNo exposure of internal network, enable/disable anytime | Web-based interface\u003cbr/\u003eInstall and use in seconds | Supports Linux/macOS/Windows\u003cbr/\u003ex86_64 and ARM64 | Auto-discover device applications\u003cbr/\u003eZero manual configuration |\n\n\u003c/div\u003e\n\n### 🎯 Why Choose Liaison?\n\n- **🔒 Enterprise-Grade Security** - TLS encrypted transmission, internal network penetration solution, no internal network exposure, secure and controllable\n- **⚡ Lightning-Fast Deployment** - Complete all operations through the Web interface, no complex configuration, install and use in seconds\n- **🌍 Full Platform Support** - Supports Linux, macOS, Windows and multiple architectures\n- **🤖 Smart Discovery** - Automatically discover applications and services on devices, zero configuration required\n- **📊 Visual Monitoring** - Real-time device status and traffic statistics at a glance\n\n---\n\n## 🚀 Quick Start\n\n### 📦 Install Server\n\n**1. Download Installation Package**\n\n```bash\n# Download latest version\nwget https://github.com/singchia/liaison/releases/download/v1.2.6/liaison-v1.2.6-linux-amd64.tar.gz\n\n# Extract\ntar -xzf liaison-v1.2.6-linux-amd64.tar.gz\ncd liaison-v1.2.6-linux-amd64\n```\n\n**2. Run Installation Script**\n\n```bash\nsudo ./install.sh\n```\n\nDuring installation, you'll be prompted to enter a public IP address or domain name. If no input is provided within 30 seconds, the detected public IP will be used automatically.\n\n**3. Access Web Console**\n\nAfter installation, visit `https://your-public-ip` to access the Web console.\n\n\u003e 💡 **Tip**: Default admin credentials can be found in the installation script output or configuration file\n\n### 🔌 Install Connector\n\n**1. Create Connector**\n\nCreate a connector in the Web console and obtain `Access Key` and `Secret Key`.\n\n**2. Install on Target Device**\n\n**Linux/macOS:**\n```bash\ncurl -sSL https://your-server-address/install.sh | bash -s -- \\\n  --access-key=YOUR_ACCESS_KEY \\\n  --secret-key=YOUR_SECRET_KEY\n```\n\n**Windows:**\n```powershell\n# Download installation script\nInvoke-WebRequest -Uri \"https://your-server-address/install.ps1\" -OutFile \"install.ps1\"\n\n# Run installation\n.\\install.ps1 -AccessKey \"YOUR_ACCESS_KEY\" -SecretKey \"YOUR_SECRET_KEY\"\n```\n\n**3. Wait for Auto Connection**\n\nWait a few seconds, and the device will automatically appear in the console without additional configuration!\n\n---\n\n## 📋 System Requirements\n\n| Component | Requirements |\n|:---|:---|\n| **Server** | Linux system (Ubuntu 20.04+ or CentOS 7+ recommended) |\n| **Connector** | Linux / macOS / Windows (x86_64 and ARM64 architectures supported) |\n| **Browser** | Chrome 90+, Firefox 88+, Safari 14+, Edge 90+ |\n\n---\n\n## 🏗️ Architecture\n\n\u003cdiv align=\"center\"\u003e\n\n![Architecture](docs/diagrams/liaison.png)\n\n**Liaison uses a centralized architecture, with Frontier service managing all connectors**\n\n\u003c/div\u003e\n\n### Core Components\n\n- **Manager** - Management center, provides Web interface and API\n- **Frontier** - Connector gateway, handles all connector connections and communications\n- **Edge** - Connector client, deployed on target devices\n\n---\n\n## 💡 Use Cases\n\n\u003cdiv align=\"center\"\u003e\n\n| 🏠 **Remote Work** | 📦 **NAS Companion** | 🏢 **Multi-Datacenter** | ⚡ **Edge Computing** |\n|:---:|:---:|:---:|:---:|\n| Connect office and home devices\u003cbr/\u003eAccess anytime, anywhere | Access home NAS\u003cbr/\u003efrom the internet | Unified connection of servers\u003cbr/\u003eacross different datacenters | Connect and monitor applications\u003cbr/\u003eand services on edge devices |\n\n\u003c/div\u003e\n\n### Typical Applications\n\n- 🏡 **Home Network** - Access home NAS, smart home devices\n- 💼 **Remote Development** - Connect to office servers, remote development and debugging\n- 🏢 **Enterprise Intranet** - Securely access internal network services without exposing the intranet\n- 🌐 **Multi-Region Deployment** - Unified management of devices distributed across different regions\n- 🔧 **Operations Management** - Remote server management, device status monitoring\n\n---\n\n## 📸 Feature Showcase\n\n\u003cdiv align=\"center\"\u003e\n\n### Dashboard\n![Dashboard](docs/pages/dashboard.png)\n\n### Device Management\n![Device](docs/pages/device.png)\n\n### Application Management\n![Application](docs/pages/application.png)\n\n### Proxy Configuration\n![Proxy](docs/pages/proxy.png)\n\n### Connector Management\n![Connector](docs/pages/connector.png)\n\n\u003c/div\u003e\n\n---\n\n## 📚 Documentation\n\n- [Business Flow Diagram](./docs/biz_sequence.md)\n- [API Documentation](./docs/swagger/)\n- [Installation Guide](./dist/liaison/README.md)\n- [Connector Installation](./dist/edge/README.md)\n\n---\n\n## 🤝 Contributing\n\nWe welcome all forms of contributions!\n\n- 🐛 [Report Bug](https://github.com/singchia/liaison/issues/new?template=bug_report.md)\n- 💡 [Suggest Feature](https://github.com/singchia/liaison/issues/new?template=feature_request.md)\n- 📝 [Submit PR](https://github.com/singchia/liaison/pulls)\n- 📖 [Improve Documentation](https://github.com/singchia/liaison/issues/new?template=documentation.md)\n\n### Contribution Guidelines\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n---\n\n## 📄 License\n\nThis project is licensed under the [Apache License 2.0](LICENSE).\n\n```\nCopyright 2026 Liaison Contributors\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n---\n\n## ⭐ Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=singchia/liaison\u0026type=Date)](https://star-history.com/#singchia/liaison\u0026Date)\n\n---\n\n## 🙏 Acknowledgments\n\nThanks to all developers who have contributed to Liaison!\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**If this project helps you, please give it a ⭐ Star!**\n\nMade with ❤️ by [Liaison Contributors](https://github.com/singchia/liaison/graphs/contributors)\n\n[GitHub](https://github.com/singchia/liaison) • [Issues](https://github.com/singchia/liaison/issues) • [Discussions](https://github.com/singchia/liaison/discussions)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsingchia%2Fliaison","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsingchia%2Fliaison","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsingchia%2Fliaison/lists"}