docs: document I2P deployment and compose validation (#35)

Author: archief2910

.env.example

@@ -67,3 +67,8 @@ WORKER_COUNT=2 # Defaults to CPU count. Use 1 or 2 for local testing.
 # TOR_CONTROL_PORT=9051
 # TOR_PASSWORD=
 # HIDDEN_SERVICE_PORT=80
+
+# --- I2P (Optional) ---
+# To enable I2P, use: ./scripts/start_with_i2p
+# I2P tunnel configuration lives in i2p/tunnels.conf and i2p/i2pd.conf.
+# No application-level env vars are needed; the i2pd sidecar handles everything.

CONFIGURATION.md

@@ -58,6 +58,23 @@ The following environment variables can be set:
 | DEBUG                            | Debugging filter                 |                        |
 | ZEBEDEE_API_KEY                  | Zebedee Project API Key          |                        |
 
+## I2P
+
+I2P support is provided as a sidecar container (i2pd) via `docker-compose.i2p.yml`, mirroring the Tor setup. No application-level environment variables are needed — the i2pd container creates an I2P server tunnel that forwards traffic to nostream's WebSocket port.
+
+Configuration files live in the `i2p/` directory:
+
+| File | Description |
+|------|-------------|
+| `i2p/tunnels.conf` | Defines the I2P server tunnel pointing at nostream (port 8008). |
+| `i2p/i2pd.conf` | Minimal i2pd daemon configuration. |
+
+Tunnel keys are persisted at `.nostr/i2p/data/` so the `.b32.i2p` address survives container restarts.
+
+- Start with I2P: `./scripts/start_with_i2p`
+- Print hostname hints: `./scripts/print_i2p_hostname`
+- Validate compose merges without starting containers (requires Docker): `npm run compose:validate` (same logic as the `compose-validate` CI job).
+
 If you've set READ_REPLICAS to 4, you should configure RR0_ through RR3_.
 
 # Settings

README.md

@@ -234,6 +234,22 @@ Print the Tor hostname:
   ./scripts/print_tor_hostname
   ```
 
+Start with I2P:
+  ```
+  ./scripts/start_with_i2p
+  ```
+
+Print the I2P hostname:
+  ```
+  ./scripts/print_i2p_hostname
+  ```
+
+Verify that Docker Compose files merge correctly (no stack started; requires Docker on PATH):
+  ```
+  npm run compose:validate
+  ```
+  This runs `docker compose … config -q` for the I2P-only, Tor-only, and Tor+I2P overlay combinations (same check as the `compose-validate` CI job).
+
 ### Importing events from JSON Lines
 
 You can import NIP-01 events from a `.jsonl` file directly into the relay database.