YUME documentation

This map covers YUME 0.3.0-dev1. Its yume and yumed speak YTP/1.

Run YUME

• Quick start: build, create a kit, and connect.
• Operations: server deployment, client identities, limits, reloads and troubleshooting.
• Configuration reference: every key of the schema-1 configuration and the tuning presets.
• Preventing SOCKS bypass: browser settings and route checks.
• Desktop GUI: importing kits and starting, stopping and watching clients in a window.
• Client manual, daemon manual and GUI manual.
• Packaging: install layout and Debian packages.

Understand YUME

• YUME explained: how a connection opens, the keys, and what each party can see.
• Why YUME: goals, priorities and dependency choices.
• Threat model: attackers, operators and metadata limits.
• Stealth and transport profiles: the browser-shaped carrier and what captures show.
• Implementation status: what is tested and what still blocks a release.
• Glossary.

Develop and embed

• Source map and contributor guide.
• Architecture: component ownership and dependency direction.
• YTP/1: the wire and security contract.
• Relay channel: the end-to-end channel the relay module keeps for the planned chat and file modules.
• Sealed kit: the one-file format that moves a client kit to another device.
• Control protocol 1: the owner-only socket through which the GUI and yume --status talk to a running client or daemon.
• C ABI: embedding the client or server in another program.
• Modules: running a program behind a stream service, and writing one.
• YTP/1 development guide: build options, setup tools, embedding and verification gates.
• Developer diagnostics: timing helpers, warnings, sanitizers and fuzzing.
• Development notes, SBOM and automation guidance.

Source and tests win when prose disagrees. Generated pages come from .doc sources under docs/src. Edit the source named in the banner, then run the sync described there.