This is the documentation home for Queqiao, an open-source transport for making difficult, known long-haul links faster and more reliable. The repository README is the best introduction; this index helps you choose the next document based on what you want to do.
| If you want to… | Read |
|---|---|
| Understand the problem and the design principles | Vision and principles |
| Decide whether Queqiao fits your network | Project status and known limitations |
| Use a provider and client | Deployment guide |
| Understand the transport in depth | Current design, then architecture |
| Measure a path or compare a baseline | Benchmarking |
| Contribute code, documentation, or network results | Contributing |
- Deployment guide — provider setup, invitations, desktop enrollment, multi-provider clients, Clash/mihomo, service installation, monitoring, upgrades, and rollback.
- Runtime logging — log locations, rotation, telemetry, and safe evidence collection.
- Mobile clients — Android and iOS builds, product boundaries, and release requirements.
- Android export mode — how the released Android app provides a local SOCKS5 endpoint to an existing routing client.
- Known limitations — scope, privacy, topology, platform, and operational limits to check before deployment.
- Vision and principles — the durable problem statement and the assumptions that should survive mechanism changes.
- Current design — the measured loss model, recovery, pacing, pooling, fallback, and rejected alternatives behind protocol 1.
- Comparing transports — architectural differences and a clearly labeled historical TUIC/Hysteria2 comparison.
- Architecture — components, flow lifecycle, trust boundaries, resource limits, and carrier behavior.
- Protocol version 1 — the normative wire contract, framing, authentication, recovery, and conformance rules.
- Path characterization — the open-loop measurement that exposed the motivating path's erasure floor and congestion knee.
- Benchmarking — reproducible short-lived, interactive, and bulk workload measurements.
- Field validation — the real-network matrix for NAT, middleboxes, access diversity, and release qualification.
- Field-result index — current protocol-1 records; historical records are kept separate until they qualify the current wire.
- Production design criteria — the stronger bar for a production-ready claim.
- Public release checklist — the authority for preview publication and release evidence.
- Contributing guide — development checks, pull requests, changelog entries, protocol changes, and safe reporting.
- Contributing network evidence — how to share measurements and counterexamples without exposing private data.
- Roadmap — what is implemented, what was retired, and what qualification work remains.
- Releasing — changelog assembly, reproducible archives, installation, and rollback.
- Mobile memory — resource budgets for the packet-tunnel extension.
The archive preserves dated measurements, rejected designs, audits, and release experiments. Archive documents may describe old wire versions, invalid measurements, or removed commands. They are useful provenance, not current operational guidance; when an archived record differs from a current document, the current document wins.