Documentation/public-inbox-nntpd.pod

   1 =head1 NAME
   2
   3 public-inbox-nntpd - NNTP server for sharing public-inbox
   4
   5 =head1 SYNOPSIS
   6
   7   public-inbox-nntpd [OPTIONS]
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-nntpd provides a read-only NNTP daemon for
  12 public-inbox.  It uses options and environment variables common
  13 to all L<public-inbox-daemon(8)> implementations.
  14
  15 The default configuration will never require write access
  16 to the directory where the public-inbox is stored, so it
  17 may be run as a different user than the user running
  18 L<public-inbox-watch(1)>, L<public-inbox-mda(1)>, or
  19 L<git-fetch(1)>.
  20
  21 =head1 OPTIONS
  22
  23 See common options in L<public-inbox-daemon(8)/OPTIONS>.
  24 Additionally, NNTP-specific behavior for certain options
  25 are supported and documented below.
  26
  27 =over
  28
  29 =item -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
  30
  31 =item --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
  32
  33 In addition to the normal C<-l>/C<--listen> switch described in
  34 L<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or
  35 C<nntps://>) may be specified to force a given protocol.
  36
  37 For STARTTLS and NNTPS support, the C<cert> and C<key> may be specified
  38 on a per-listener basis after a C<?> character and separated by C<,>.
  39 These directives are per-directive, and it's possible to use a different
  40 cert for every listener.
  41
  42 =item --cert /path/to/cert
  43
  44 The default TLS certificate for optional STARTTLS and NNTPS support
  45 if the C<cert> option is not given with C<--listen>.
  46
  47 If using systemd-compatible socket activation and a TCP listener on port
  48 563 is inherited, it is automatically NNTPS when this option is given.
  49 When a listener on port 119 is inherited and this option is given, it
  50 automatically gets STARTTLS support.
  51
  52 =item --key /path/to/key
  53
  54 The default private TLS certificate key for optional STARTTLS and NNTPS
  55 support if the C<key> option is not given with C<--listen>.  The private
  56 key may be concatenated into the path used by C<--cert>, in which case this
  57 option is not needed.
  58
  59 =back
  60
  61 =head1 CONFIGURATION
  62
  63 These configuration knobs should be used in the
  64 L<public-inbox-config(5)>
  65
  66 =over 8
  67
  68 =item publicinbox.<name>.newsgroup
  69
  70 =item publicinbox.nntpserver
  71
  72 =back
  73
  74 See L<public-inbox-config(5)> for documentation on them.
  75
  76 =head1 CONTACT
  77
  78 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  79
  80 The mail archives are hosted at L<https://public-inbox.org/meta/>, and
  81 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
  82 L<nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
  83
  84 =head1 COPYRIGHT
  85
  86 Copyright 2013-2021 all contributors L<mailto:meta@public-inbox.org>
  87
  88 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  89
  90 =head1 SEE ALSO
  91
  92 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
  93 L<public-inbox-config(5)>