From 0e060545650d2f4935b504c1b69a0175fd7ff6f6 Mon Sep 17 00:00:00 2001
From: Caleb James DeLisle <cjd@cjdns.fr>
Date: Mon, 4 Nov 2024 17:49:13 +0100
Subject: [PATCH] Update cjdns node instructions

---
 README.md                |  6 ++++++
 docs/infra/cjdns-node.md | 43 +++++++++++++++++++++++++++++-----------
 2 files changed, 37 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 7e67bfe..e52be1c 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,12 @@
 This is the documentation for the PKT project.
 When you push to this repository, github will build the documentation.
 
+## Editing
+
+To edit the documentation, edit the markdown files inside of the `/docs` subdirectory.
+
+## Building
+
 To test the documentation before submitting your pull request, run:
 
 ```bash
diff --git a/docs/infra/cjdns-node.md b/docs/infra/cjdns-node.md
index cc06525..89511ca 100644
--- a/docs/infra/cjdns-node.md
+++ b/docs/infra/cjdns-node.md
@@ -8,27 +8,46 @@ A server running debian based Linux (preferably Ubuntu 22.04).
 
 ## Steps
 
-* Determine your *Peer ID*.
+### 1. Determine your *Peer ID*.
 <span class="cjdns-peer-id-has" style="display:none">Your Peer ID is <code class="cjdns-peer-id">MISSING</code></span>
 <span class="cjdns-peer-id-missing">To get your Peer ID, first register your cjdns node on the PKT Dashboard.</span>
 
-* Install `cjdns.sh`
+### 2. Install cjdns.sh
 
-    <code>
-    curl https://pkt.cash/special/cjdns/cjdns.sh | CJDNS_PEERID=<span class="cjdns-peer-id">&lt;peer-id-goes-here&gt;</span> CJDNS_ADMIN_PORT=11234 CJDNS_TUN=1 sh
-    </code>
+<code>
+curl https://pkt.cash/special/cjdns/cjdns.sh | CJDNS_PEERID=<span class="cjdns-peer-id">&lt;peer-id-goes-here&gt;</span> sh
+</code>
 
-* Check if you have peers working
+### 3. Check if you have peers working
 
-    ```
-    cjdnstool peers show
-    ```
+```
+cjdnstool peers show
+```
 
-* Make sure your firewall is open. Port 3478 must be accessible from the public internet.
+### 4. Make sure your firewall is open.
 
-    `iptables-save`
+Port `3478` must be accessible from the public internet.
 
-    `nft list ruleset`
+```
+iptables-save
+```
+
+```
+nft list ruleset
+```
+
+### 5. Check the tester
+
+Your node should appear on [The Cjdns Peer Tester](https://vinny.cjdns.fr/ptest/).
+
+* It should appear within 5 minutes of being started, and should bt tested after 10.
+* It will be identified by its Peer ID.
+* `OK` means your node passed the test, `ConnectTimeout` means your node could not be reached.
+
+### 6. Wait for the dashboard to update
+
+After the tester has approved your node, the dashboard should update soon after.
+When the dashboard shows green, your node is all set to begin yielding.
 
 ## Different public port