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 CONFIGURATION
  22
  23 These configuration knobs should be used in the
  24 L<public-inbox-config(5)>
  25
  26 =over 8
  27
  28 =item publicinbox.<name>.newsgroup
  29
  30 =item publicinbox.nntpserver
  31
  32 =back
  33
  34 See L<public-inbox-config(5)> for documentation on them.
  35
  36 =head1 CONTACT
  37
  38 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  39
  40 The mail archives are hosted at L<https://public-inbox.org/meta/>,
  41 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
  42 L<nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta>
  43
  44 =head1 COPYRIGHT
  45
  46 Copyright 2013-2019 all contributors L<mailto:meta@public-inbox.org>
  47
  48 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  49
  50 =head1 SEE ALSO
  51
  52 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
  53 L<public-inbox-config(5)>