summaryrefslogtreecommitdiffstats
path: root/nym/README.md
diff options
context:
space:
mode:
authorGab <24553253+gabrix73@users.noreply.github.com>2026-08-14 20:39:22 +0200
committerGab <24553253+gabrix73@users.noreply.github.com>2026-08-14 20:39:22 +0200
commit43fbddf016f94f4ba006d82c9a67dca61b5852a1 (patch)
tree70054d5fa8a34bb094b8c3ef8ddc9c1fcea3b3d5 /nym/README.md
parent994071243fc80990cf09e820b671006e9bd31c76 (diff)
downloadyamnweb-43fbddf016f94f4ba006d82c9a67dca61b5852a1.tar.gz
yamnweb-43fbddf016f94f4ba006d82c9a67dca61b5852a1.tar.xz
yamnweb-43fbddf016f94f4ba006d82c9a67dca61b5852a1.zip
Complete Nym and YAMN transport integration
Diffstat (limited to 'nym/README.md')
-rw-r--r--nym/README.md27
1 files changed, 20 insertions, 7 deletions
diff --git a/nym/README.md b/nym/README.md
index 0cd4f10..bddd379 100644
--- a/nym/README.md
+++ b/nym/README.md
@@ -1,8 +1,10 @@
# 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.
+This binary sends already encrypted YAMN envelopes through the Nym mixnet
+using the Rust SDK. Its production daemon mode owns one persistent Nym client
+and accepts a bounded queue over a local Unix socket. The queue exists only in
+RAM. 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:
@@ -10,13 +12,24 @@ Configuration is supplied through the environment:
- `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`.
+- `YAMN_NYM_SOCKET`: daemon socket path directly inside `/run/yamnweb`.
+- `YAMN_NYM_QUEUE_CAPACITY`: maximum in-memory queue size, from 1 to 64.
-The request is one JSON object on standard input:
+Production daemon mode:
+
+```sh
+yamn-nym-submit --daemon
+```
+
+The Unix socket and the compatibility standard-input mode accept one JSON
+object:
```json
{"entry_address":"yamn@example.org","payload":"<raw encrypted YAMN SMTP envelope>"}
```
-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`.
+The daemon acknowledges a request after validation and insertion into the
+bounded RAM queue. It never logs or persists 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`.