Canonical docs, published from the source tree

Build, operate, or integrate YUME.

Build YUME, check its trust boundaries, or open the public contracts. Current support and release limits live in implementation status.

Build from source Check support

Documentation

Start here

Quick start Build, provision, and connect the native YTP/1 client and daemon. Read YTP/1 development guide Build options, schema-1 kits, the native runtimes, managed TUN, embedding and verification gates. Read YUME explained How yume and yumed carry traffic: the connection, the keys, streams and policy, and what stays visible. Read Why YUME Internet freedom, the dream behind the name, and YUME's security, stealth and speed priorities. Read YUME glossary Plain definitions of the terms YUME's documentation uses. Read Operations Provisioning, service deployment, client identities, limits, release verification and troubleshooting for native yume and yumed. Read Desktop GUI The yume-gui window: importing kits, starting and stopping tunnels, and what each page shows and why. Read Implementation status What exists, what has focused tests, and what still blocks a stable release. Read

Security and transport

Stealth transport Browser-shaped TLS, the HTTP/2 carrier, the cover site, and the remaining differences. Read YTP/1 threat model Session protection, endpoint trust, metadata visibility and resource bounds. Read Transport profiles How a captured browser and server identity enter the immutable registry. Read YTP/1 protocol The canonical transport kernel, native composition and qualification boundaries. Read Relay channel The end-to-end channel two YUME users run through a relaying server: handshake, records, ratchet and rekey. Read Sealed kit The one-file format that carries a client kit to another device, opened with a generated code. Read Cluster links The signed server list, the peer store and the links that make one operator's yumed servers a cluster. Read Circuits Cells, the per-hop handshake, layered encryption and relay messages of the circuits that carry a client's traffic through two or three cluster servers. Read

Operating

Preventing SOCKS bypass Browser proxy settings, route checks, and what a SOCKS proxy cannot enforce. Read Diagnostics Timing helpers, benchmark probes, compiler warnings, sanitizers and fuzzing for native builds, and what each result can show. Read

Reference and development

Configuration Every key of the schema-1 configuration that yume and yumed read, with its role, bounds and meaning. Read Packaging Local installs, man pages, and the Debian package split. Read Source map Where each part of the native runtime lives, how data and keys move through it, and which checks enforce the layers. Read YTP/1 architecture Native component ownership, dependency direction, and runtime boundaries. Read Experimental C ABI The experimental C interface for embedding YUME: lifetimes, statuses, symbols and freeze gates. Read Modules Programs that serve a stream service: configuration, the systemd units, what the program receives, the connection header and the trust boundary. Read Control socket The owner-only local socket where yume and yumed report their state and take requests, and the rules that let the GUI and later tools extend it. Read Full documentation map Every YUME document, grouped by what you want to do. Read