Skip to content

Commit

Permalink
Update cjdns node instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdelisle committed Nov 4, 2024
1 parent d6f82bc commit 0e06054
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 12 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
43 changes: 31 additions & 12 deletions docs/infra/cjdns-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 0e06054

Please sign in to comment.