public-inbox-nntpd(1)

1PUBLIC-INBOX-NNTPD(1)      public-inbox user manual      PUBLIC-INBOX-NNTPD(1)
2
3
4

NAME

6       public-inbox-nntpd - NNTP server for sharing public-inbox
7

SYNOPSIS

9         public-inbox-nntpd [OPTIONS]
10

DESCRIPTION

12       public-inbox-nntpd provides a read-only NNTP daemon for public-inbox.
13       It uses options and environment variables common to all
14       public-inbox-daemon(8) implementations.
15
16       The default configuration will never require write access to the
17       directory where the public-inbox is stored, so it may be run as a
18       different user than the user running public-inbox-watch(1),
19       public-inbox-mda(1), or git-fetch(1).
20

OPTIONS

22       See common options in "OPTIONS" in public-inbox-daemon(8).
23       Additionally, NNTP-specific behavior for certain options are supported
24       and documented below.
25
26       -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
27       --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
28           In addition to the normal "-l"/"--listen" switch described in
29           public-inbox-daemon(8), the protocol prefix (e.g. "nntp://" or
30           "nntps://") may be specified to force a given protocol.
31
32           For STARTTLS and NNTPS support, the "cert" and "key" may be
33           specified on a per-listener basis after a "?" character and
34           separated by ",".  These directives are per-directive, and it's
35           possible to use a different cert for every listener.
36
37       --cert /path/to/cert
38           The default TLS certificate for optional STARTTLS and NNTPS support
39           if the "cert" option is not given with "--listen".
40
41           If using systemd-compatible socket activation and a TCP listener on
42           port 563 is inherited, it is automatically NNTPS when this option
43           is given.  When a listener on port 119 is inherited and this option
44           is given, it automatically gets STARTTLS support.
45
46       --key /path/to/key
47           The default private TLS certificate key for optional STARTTLS and
48           NNTPS support if the "key" option is not given with "--listen".
49           The private key may concatenated into the path used by "--cert", in
50           which case this option is not needed.
51

CONFIGURATION

53       These configuration knobs should be used in the public-inbox-config(5)
54
55       publicinbox.<name>.newsgroup
56       publicinbox.nntpserver
57
58       See public-inbox-config(5) for documentation on them.
59

CONTACT

61       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
62
63       The mail archives are hosted at <https://public-inbox.org/meta/>, and
64       <nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
65       <nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
66

COPYRIGHT

68       Copyright 2013-2021 all contributors <mailto:meta@public-inbox.org>
69
70       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
71