From 994071243fc80990cf09e820b671006e9bd31c76 Mon Sep 17 00:00:00 2001 From: Gab <24553253+gabrix73@users.noreply.github.com> Date: Thu, 13 Aug 2026 14:04:30 +0200 Subject: Separate active YAMN code from Katzenpost PoC --- nym/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 nym/README.md (limited to 'nym/README.md') diff --git a/nym/README.md b/nym/README.md new file mode 100644 index 0000000..0cd4f10 --- /dev/null +++ b/nym/README.md @@ -0,0 +1,22 @@ +# YAMN Nym sender + +This binary sends an already encrypted YAMN envelope through the Nym mixnet +using the Rust SDK. It is intentionally send-only: it does not receive +messages, expose replies, fetch remailer data, or perform YAMN encoding. + +Configuration is supplied through the environment: + +- `YAMN_NYM_RECIPIENT`: fixed Nym address of the YAMN ingress service. +- `YAMN_ENTRY_ADDRESS`: exact allowlisted YAMN entry address used by the ingress. +- `YAMN_NYM_STORAGE`: persistent client storage directory. Defaults to + `/var/lib/yamnweb/nym-client`. + +The request is one JSON object on standard input: + +```json +{"entry_address":"yamn@example.org","payload":""} +``` + +The binary never logs the request or its contents. The Nym recipient must be +an ingress service that knows how to hand the envelope to YAMN. A normal SMTP +address is not a valid replacement for `YAMN_NYM_RECIPIENT`. -- cgit v1.2.3