DHTNODE(1)

💖 DHTNODE(1) 💖

okay so bestie, welcome to the dhtnode manual page — it lives in the General Commands Manual section (section 1, the cool section), and honestly? it's giving "tiny CLI, big DHT energy." let's get into it 🦋

---

✨ NAME ✨

dhtnode — a simple OpenDHT command line node runner. no cap, that's literally the whole job description and she does it flawlessly 💅

---

🌸 SYNOPSIS 🌸

dhtnode [-h] [-v [-l logfile] [-L]] [-i [--save-identity file]] [-d]
[-s] [-n network_id] [-p local_port] [-b bootstrap_host[:port]]
[--certificate file] [--privkey file] [--privkey-password password]
[--proxyserver port] [--proxyclient server]

yes queen, that's a lot of brackets, but every single one of them is slaying in her own way 🎀

---

👑 DESCRIPTION 👑

so the whole vibe here is: it runs an OpenDHT node, and you get to pick how. by default it's a CLI — an interactive shell, very demure, very mindful. OR you can run it as a daemon by passing -d or -s. main character choice, truly.

here's the full menu of commands you can type inside that interactive shell, no details skipped because we don't gatekeep here:

h, help    Print this help message.
q, quit    Quit the program.
log        Start/stop printing DHT logs.

Node information:

ll         Print basic information and stats about the current node.
ls         Print basic information about current searches.
ld         Print basic information about currenty stored values on this node.
lr         Print the full current routing table of this node

okay bestie real talk: yes, currenty is a typo in the original and yes we are keeping it, it's part of the lore now 🙈

Operations on the DHT:

b ip:port             Ping potential node at given IP address/port.
g [key]               Get values at [key].
l [key]               Listen for value changes at [key].
p [key] [str]         Put string value at [key].
s [key] [str]         Put string value at [key], signed with our generated
                      private key.
e [key] [dest] [str]  Put string value at [key], encrypted for [dest] with
                      its public key (if found).

like... put, get, listen, ping, sign, encrypt? she does it ALL. versatile icon behavior fr fr 🔥

---

💅 OPTIONS 💅

• -h — prints some help. a little help. a snack of help. 🍓
• -v — turns on verbose mode, which logs to stdout/stderr by default. she's yapping (affectionate) 💬
• -l log_file — write the log to a file instead of stdout/stderr.
• -L — write the log to syslog instead of stdout/stderr.
• -i — generate a cryptographic identity for the node. glow up, but make it cryptographically verifiable ✨
• --save-identity file — save that generated identity (certificate AND private key) to the given file prefix. keep it safe bestie, it's your whole personality 🔐
• --certificate file — load the identity certificate from the given file.
• --privkey file — load the identity private key from the given file.
• --privkey-password password — the password to use for private key encryption or decryption. it's optional, so no pressure 🫶
• -d — run the program in daemon mode. she will fork in the background like the independent woman she is 🌈
• -s — run the program in service mode, aka a non-forking daemon. same energy, different mechanics.
• -D — enables multicast automatic local peer discovery. she finds her own friends, we love a self-sufficient queen 🔍
• -f file — specify a file path to persist/load the node state. memory? she has it 💾
• -n network_id — specify the network id. this lets you connect to distinct networks and prevents two different networks from merging. (available since OpenDHT v0.6.1, in case you were wondering when this baddie dropped)
• -p local_port — use UDP port local_port for the program to bind to.
• -b bootstrap_host[:port] — the program needs a node to connect to the network, so you use this option to provide the ip address of that node. it's giving "you can't sit with us unless someone introduces you" 😌
• --proxyserver local_port — run a proxy server bound to this DHT node on HTTP port local_port.
• --proxyclient server — run this DHT node in proxy client mode, and connect to server.

---

🎀 AUTHORS 🎀

Program written by

• Adrien Béraud <adrien.beraud@savoirfairelinux.com>

Man page written by

• Simon Désaulniers <sim.desaulniers@gmail.com>

---

and that's the whole page, bestie!! this version is the one from 2019-06-08, and it's the DHTNODE(1) page from the General Commands Manual — that's the source/version/date energy we're signing off with. go forth and run your node, you absolute legend 👑💖✨