GNB(8)

💖 GNB(8) — the girlies' guide to gnb 💖

okay so bestie, welcome to the gnb manual page, section 8 of the System Manager's Manual, and honestly? this one's a whole vibe. gnb is the command that sets up the VPN used by opengnb. that's it, that's the job. let's get into it ✨

---

🌸 NAME 🌸

gnb — the gnb command that sets up the VPN used by opengnb. no cap, that's literally what it does 💅

---

🎀 SYNOPSIS 🎀

gnb [-i IFNAME] -c CONFIG_PATH [OPTION]

so like, -c CONFIG_PATH is the main character here — she's required, she's not optional, she's the whole point. everything else is supporting cast 🫶

---

✨ DESCRIPTION ✨

okay so first thing, the lore:

GNB version 1.2.8.1, protocol version 1.1.2. iconic. we love a version number that knows what it is 👑

registered packet filter:

• gnb_pf_dump
• gnb_pf_route
• gnb_pf_crypto_xor
• gnb_pf_crypto_arc4

those are the filters, they're registered, they said "we're here" and they showed up 💜

---

🌈 Command Summary: 🌈

not me listing every single one of these. i would never skip a single flag, because you deserve the full picture, bestie. here we go:

• -c, --conf — config path. the path to your config. she's essential, don't skip her.
• -n, --nodeid — nodeid. your node's id, so she knows who she is 🦋
• -P, --public-index-service — run as public index service. main character mode: public.
• -I, --index-address — index address. where the index lives.
• -a, --node-address — node ip address. the ip of the node.
• -r, --node-route — node route. the route, for the node.
• -i, --ifname — TUN Device Name. it's gnb_tun in Linux default, fyi.
• -4, --ipv4-only — Use IPv4 Only. four only, no six, respectfully.
• -6, --ipv6-only — Use IPv6 Only. six only, no four, also respectfully.
• -d, --daemon — daemon. she goes to the background. mysterious. elusive. 🧚
• -q, --quiet — disabled console output. shhh 🤫
• -t, --selftest — self test. she checks herself before she wrecks herself.
• -p, --passcode — a hexadecimal string of 32-bit unsigned integer, used to strengthen safety. default is 0x9d078107. keep this secret bestie, i'm serious 💀
• -l, --listen — listen address. default is '0.0.0.0:9001'.
• -b, --ctl-block — ctl block mapper file.
• -e, --es-argv — pass-through gnb_es argv. you're just handing stuff off to the other girlie.
• -V, --verbose — verbose mode. she talks a LOT. love that for her.
• --node-woker-queue — node woker queue length. (yes, it's spelled woker in the original, we don't correct the queen, we copy her exactly 🫶)
• --index-woker-queue — index woker queue length.
• --index-service-woker-queue — index service woker queue length.
• --port-detect-start — port detect start.
• --port-detect-end — port detect end.
• --port-detect-range — port detect range.
• --mtu — TUN Device MTU. ipv4: 532～1500, ipv6: 1280～1500. pick a number in range, she's not flexible about it.
• --crypto — ip frame crypto. 'xor' or 'arc4' or 'none', default is 'xor'.
• --crypto-key-update-interval — crypto key update interval. 'hour' or 'minute' or none, default is 'none'.
• --multi-index-type — 'simple-fault-tolerant' or 'simple-load-balance' or 'full', default is 'simple-load-balance'.
• --multi-forward-type — 'simple-fault-tolerant' or 'simple-load-balance', default is 'simple-fault-tolerant'.
• --socket-if-name — example: 'eth0', 'eno1', only for unix-like os. windows girlies, this one's not for you 🙈
• --address-secure — hide part of ip address in logs. 'on' or 'off', default is 'on'.
• --if-dump — dump the interface data frame. 'on' or 'off', default is 'off'.
• --pf-route — packet filter route.
• --multi-socket — 'on' or 'off', default is 'off'.
• --direct-forwarding — 'on' or 'off', default is 'on'.
• --set-tun — 'on' or 'off', default is 'on'.
• --index-worker — 'on' or 'off', default is 'on'.
• --index-service-worker — 'on' or 'off', default is 'on'.
• --node-detect-worker — 'on' or 'off', default is 'on'.
• --set-fwdu0 — 'on' or 'off', default is 'on'.
• --pid-file — pid file.
• --node-cache-file — node address cache file.
• --log-file-path — log file path.
• --log-udp4 — send log to the address ipv4. default is '127.0.0.1:9000'.
• --log-udp-type — log udp type. 'binary' or 'text', default is 'binary'.
• --console-log-level — log console level, 0-3.
• --file-log-level — log file level, 0-3.
• --udp-log-level — log udp level, 0-3.
• --core-log-level — core log level, 0-3.
• --pf-log-level — packet filter log level, 0-3.
• --main-log-level — main log level, 0-3.
• --node-log-level — node log level, 0-3.
• --index-log-level — index log level, 0-3.
• --index-service-log-level — index service log level, 0-3.
• --node-detect-log-level — node detect log level, 0-3.
• --help — the classic. she helps. 💖

---

🦋 Example: 🦋

the way these examples are just sitting here being useful. periodt:

./gnb -i gnbtun -c $node_conf_dir -e "--upnp"

./gnb -P

./gnb -P --console-log-level=3 --index-service-log-level=3

./gnb -n 1001 -I '$public_index_ip/$port' -p $passcode

./gnb -n 1002 -I '$public_index_ip/$port' -p $passcode

./gnb -n 1001 -a 'i/0/$public_index_ip/$port' -p $passcode

./gnb -n 1002 -a 'i/0/$public_index_ip/$port' -p $passcode

see how $node_conf_dir, $public_index_ip, $port and $passcode are placeholders? swap in your own, bestie, don't run these raw 😭

---

👑 SEE ALSO 👑

go read her sisters, they're all iconic:

• gnb_crypto(1)
• gnb_ctl(8)
• gnb_es(8)

---

🌟 HOMEPAGE 🌟

Source Code and Documentation at https://github.com/gnbdev/opengnb

(no link formatting, i know, the terminal said no. but you can copy-paste it, i believe in you 🫶)

---

💜 COPYRIGHT 💜

Copyright © 2019-2022 gnbdev <gnbdev@qq.com>

---

and that's the whole page, bestie!! this was VERSION 1.2.8.1, dated December 2021, and it's giving GNB(8) energy from start to finish. go set up that VPN, you absolute legend 💅✨