serve.zone/remoteingress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(readme): Document Hub/Edge architecture and new RemoteIngressHub/RemoteIngressEdge API; add Rust core binary, protocol and usage details; note removal of ConnectorPublic/ConnectorPrivate (breaking change)

Browse Source
This commit is contained in:
Jürgen Kunz
2026-02-16 13:15:12 +00:00
parent f79b5cf541
commit ce5074c57d
4 changed files with 185 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
readme.hints.md
View File

@@ -1,3 +1,9 @@
* this module is part of the @serve.zone stack
* it is used to reach private clusters from outside
* it can be used to create private tunnels to private networks
* This module is part of the @serve.zone stack
* v3.0.0+ uses a Hub/Edge architecture with a Rust core binary (`remoteingress-bin`)
* TypeScript classes `RemoteIngressHub` and `RemoteIngressEdge` bridge to Rust via `@push.rocks/smartrust` RustBridge IPC
* Custom multiplexed binary frame protocol over TLS for tunneling TCP connections
* PROXY protocol v1 preserves client IP when forwarding to SmartProxy/DcRouter
* Edge authenticates to Hub via shared secret over TLS
* STUN-based public IP discovery at the edge (Cloudflare STUN server)
* Cross-compiled Rust binary for linux/amd64 and linux/arm64
* Old `ConnectorPublic`/`ConnectorPrivate` classes no longer exist (removed in v2.0.0/v3.0.0)