Documentation/public-inbox-netd.pod

   1 =head1 NAME
   2
   3 public-inbox-netd - read-only network daemon for sharing public-inboxes
   4
   5 =head1 SYNOPSIS
   6
   7   public-inbox-netd [OPTIONS]
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-netd provides a read-only HTTP/IMAP/NNTP/POP3 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
  25 =over
  26
  27 =item -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
  28
  29 =item --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 =item --cert /path/to/cert
  36
  37 The default TLS certificate for optional TLS support
  38 if the C<cert> option is not given with C<--listen>.
  39
  40 =item --key /path/to/key
  41
  42 The default private TLS certificate key for optional TLS support
  43 if the C<key> option is not given with C<--listen>.  The private
  44 key may be concatenated into the path used by C<--cert>, in which case this
  45 option is not needed.
  46
  47 =back
  48
  49 =head1 CONFIGURATION
  50
  51 These configuration knobs should be used in the
  52 L<public-inbox-config(5)>.
  53
  54 =over 8
  55
  56 =item publicinbox.<name>.newsgroup
  57
  58 =item publicinbox.nntpserver
  59
  60 =back
  61
  62 See L<public-inbox-config(5)> for documentation on them.
  63
  64 =head1 CONTACT
  65
  66 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  67
  68 The mail archives are hosted at L<https://public-inbox.org/meta/>, and
  69 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
  70 L<nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
  71
  72 =head1 COPYRIGHT
  73
  74 Copyright all contributors L<mailto:meta@public-inbox.org>
  75
  76 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  77
  78 =head1 SEE ALSO
  79
  80 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
  81 L<public-inbox-config(5)>