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 multi-protocol
  12 (HTTP/IMAP/NNTP/POP3) daemon for public-inbox.  It uses options
  13 and environment variables common to all
  14 L<public-inbox-daemon(8)> implementations.
  15
  16 The default configuration will never require write access
  17 to the directory where the public-inbox is stored, so it
  18 may be run as a different user than the user running
  19 L<public-inbox-watch(1)>, L<public-inbox-mda(1)>, or
  20 L<git-fetch(1)>.
  21
  22 =head1 OPTIONS
  23
  24 See common options in L<public-inbox-daemon(8)/OPTIONS>.
  25
  26 =over
  27
  28 =item -l PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
  29
  30 =item --listen PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
  31
  32 =item -l http://ADDRESS/?env.PI_CONFIG=/path/to/cfg,psgi=/path/to/app.psgi
  33
  34 In addition to the normal C<-l>/C<--listen> switch described in
  35 L<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or
  36 C<nntps://>) may be specified to force a given protocol.
  37
  38 Environment variable overrides in effect during loading and
  39 reloading (SIGHUP) can be specified as C<env.NAME=VALUE> for
  40 all protocols.
  41
  42 HTTP(S) listeners may also specify C<psgi=> to use a different
  43 C<.psgi> file for each listener.
  44
  45 C<err=/path/to/errors.log> may be used to isolate error/debug output
  46 for a particular listener away from C<--stderr>.
  47
  48 Non-HTTP(S) listeners may also specify C<out=> for logging to
  49 C<stdout>.  HTTP(S) users are encouraged to configure
  50 L<Plack::Middleware::AccessLog> or
  51 L<Plack::Middleware::AccessLog::Timed>, instead.
  52
  53 =item --cert /path/to/cert
  54
  55 See L<public-inbox-daemon(1)>.
  56
  57 =item --key /path/to/key
  58
  59 See L<public-inbox-daemon(1)>.
  60
  61 =back
  62
  63 =head1 CONFIGURATION
  64
  65 These configuration knobs should be used in the
  66 L<public-inbox-config(5)>.
  67
  68 =over 8
  69
  70 =item publicinbox.<name>.newsgroup
  71
  72 =item publicinbox.nntpserver
  73
  74 =item publicinbox.pop3state
  75
  76 =back
  77
  78 See L<public-inbox-config(5)> for documentation on them.
  79
  80 =head1 CONTACT
  81
  82 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  83
  84 The mail archives are hosted at L<https://public-inbox.org/meta/>, and
  85 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
  86 L<nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
  87
  88 =head1 COPYRIGHT
  89
  90 Copyright all contributors L<mailto:meta@public-inbox.org>
  91
  92 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  93
  94 =head1 SEE ALSO
  95
  96 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
  97 L<public-inbox-config(5)>