PUBLIC-INBOX-NNTPD(1)

💖 public-inbox-nntpd — the girlies' guide 💖

okay bestie, sit DOWN, because this is the manual for public-inbox-nntpd from the public-inbox user manual (section 1, as in "you type man 1 and it's right there"). no cap, it's giving iconic. 🎀

---

✨ NAME ✨

public-inbox-nntpd — an NNTP server for sharing public-inbox. yes queen, that's the whole vibe. 🦋

---

🌸 SYNOPSIS 🌸

public-inbox-nntpd [OPTIONS]

---

💅 DESCRIPTION 💅

so public-inbox-nntpd is a read-only NNTP daemon for public-inbox. read-only, bestie — it's not gonna let anyone write, it's just here to serve the goods. 💖

it uses options and environment variables that are common to all public-inbox-daemon(8) implementations, so if you already know how one daemon works you already know the vibe here. iykyk.

the default configuration will never require write access to the directory where the public-inbox is stored. literally never. which means you can run it as a totally different user than the user running public-inbox-watch(1), public-inbox-mda(1), or git-fetch(1). separate users, no drama, main character energy only. ✨

---

🎀 OPTIONS 🎀

the common options live over in "OPTIONS" in public-inbox-daemon(8) — go read that too, bestie, we're not repeating all of it here. but for certain options, NNTP has its own special behavior, and those are the ones documented below. 🫶

• -l PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key, --listen PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key — okay so on top of the normal -l/--listen switch that's described in public-inbox-daemon(8), you can also specify the protocol prefix (like nntp:// or nntps://) to force a given protocol. 💅

and for STARTTLS and NNTPS support, the cert and key can be specified on a per-listener basis, after a ? character and separated by ,. these directives are per-directive, and it's possible to use a different cert for every listener. every single one. obsessed. 🔥

• --cert /path/to/cert — this is the default TLS certificate for optional STARTTLS and NNTPS support, used if the cert option is not given with --listen. and listen, if you're using systemd-compatible socket activation and a TCP listener on port 563 is inherited, it automatically becomes NNTPS when this option is given. 🦋 when a listener on port 119 is inherited and this option is given, it automatically gets STARTTLS support. automatic slay. ✨
• --key /path/to/key — the default private TLS certificate key for optional STARTTLS and NNTPS support, used if the key option is not given with --listen. the private key may be concatenated into the path used by --cert, in which case this option is not needed. so like, you can skip it if you already smooshed them together. 🫶

---

🌈 CONFIGURATION 🌈

these configuration knobs should be used in the public-inbox-config(5). 💜

• publicinbox.<name>.newsgroup
• publicinbox.nntpserver

see public-inbox-config(5) for documentation on them, bestie — that's where the details live. 📖

---

💌 CONTACT 💌

feedback is welcome via plain-text mail to <mailto:meta@public-inbox.org> — yes, plain-text, they're that kind of iconic. 😭

the mail archives are hosted at <https://public-inbox.org/meta/>, and also at <nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>, and <nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>. yes that second one is a real onion address, she's mysterious, she's got range. 🧅✨

---

👑 COPYRIGHT 👑

Copyright 2013-2021 all contributors <mailto:meta@public-inbox.org>

License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

---

🦋 SEE ALSO 🦋

git(1), git-config(1), public-inbox-daemon(8), public-inbox-config(5)

---

and that's the whole page, bestie! this was generated from public-inbox.git, dated 1993-10-02 — yeah, that date is a whole time capsule, don't think about it too hard. 💖 mwah, go run your read-only NNTP daemon, you're doing amazing. 🎀⭐