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 B<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, --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
  30
  31 In addition to the normal C<-l>/C<--listen> switch described in
  32 L<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or
  33 C<nntps://>) may be specified to force a given protocol.
  34
  35 For STARTTLS and NNTPS support, the C<cert> and C<key> may be specified
  36 on a per-listener basis after a C<?> character and separated by C<,>.
  37 These directives are per-directive, and it's possible to use a different
  38 cert for every listener.
  39
  40 =item --cert /path/to/cert
  41
  42 The default TLS certificate for optional STARTTLS and NNTPS support
  43 if the C<cert> option is not given with C<--listen>.
  44
  45 If using systemd-compatible socket activation and a TCP listener on port
  46 563 is inherited, it is automatically NNTPS when this option is given.
  47 When a listener on port 119 is inherited and this option is given, it
  48 automatically gets STARTTLS support.
  49
  50 =item --key /path/to/key
  51
  52 The default private TLS certicate key for optional STARTTLS and NNTPS
  53 support if the C<key> option is not given with C<--listen>.  The private
  54 key may concatenated into the path used by C<--cert>, in which case this
  55 option is not needed.
  56
  57 =back
  58
  59 =head1 CONFIGURATION
  60
  61 These configuration knobs should be used in the
  62 L<public-inbox-config(5)>
  63
  64 =over 8
  65
  66 =item publicinbox.<name>.newsgroup
  67
  68 =item publicinbox.nntpserver
  69
  70 =back
  71
  72 See L<public-inbox-config(5)> for documentation on them.
  73
  74 =head1 CONTACT
  75
  76 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  77
  78 The mail archives are hosted at L<https://public-inbox.org/meta/>,
  79 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
  80 L<nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta>
  81
  82 =head1 COPYRIGHT
  83
  84 Copyright 2013-2019 all contributors L<mailto:meta@public-inbox.org>
  85
  86 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  87
  88 =head1 SEE ALSO
  89
  90 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
  91 L<public-inbox-config(5)>