X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-netd.pod;h=dcf4d5b0ffc2cecdadc4a8153cce14f64db7603a;hb=refs%2Fheads%2Fmaster;hp=d6520608c009cc7d3130facd28b1ffb911711d80;hpb=93a7b219d58aad86438cbf3cbf4318a889831ac1;p=public-inbox.git diff --git a/Documentation/public-inbox-netd.pod b/Documentation/public-inbox-netd.pod index d6520608..71425e3c 100644 --- a/Documentation/public-inbox-netd.pod +++ b/Documentation/public-inbox-netd.pod @@ -8,9 +8,10 @@ public-inbox-netd - read-only network daemon for sharing public-inboxes =head1 DESCRIPTION -public-inbox-netd provides a read-only HTTP/IMAP/NNTP/POP3 daemon for -public-inbox. It uses options and environment variables common -to all L implementations. +public-inbox-netd provides a read-only multi-protocol +(HTTP/IMAP/NNTP/POP3) daemon for public-inbox. It uses options +and environment variables common to all +L implementations. The default configuration will never require write access to the directory where the public-inbox is stored, so it @@ -24,25 +25,38 @@ See common options in L. =over -=item -l PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key +=item -l PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key -=item --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key +=item --listen PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key + +=item -l http://ADDRESS/?env.PI_CONFIG=/path/to/cfg,psgi=/path/to/app.psgi In addition to the normal C<-l>/C<--listen> switch described in L, the protocol prefix (e.g. C or C) may be specified to force a given protocol. +Environment variable overrides in effect during loading and +reloading (SIGHUP) can be specified as C for +all protocols. + +HTTP(S) listeners may also specify C to use a different +C<.psgi> file for each listener. + +C may be used to isolate error/debug output +for a particular listener away from C<--stderr>. + +Non-HTTP(S) listeners may also specify C for logging to +C. HTTP(S) users are encouraged to configure +L or +L, instead. + =item --cert /path/to/cert -The default TLS certificate for optional TLS support -if the C option is not given with C<--listen>. +See L. =item --key /path/to/key -The default private TLS certificate key for optional TLS support -if the C option is not given with C<--listen>. The private -key may concatenated into the path used by C<--cert>, in which case this -option is not needed. +See L. =back @@ -57,6 +71,8 @@ L. =item publicinbox.nntpserver +=item publicinbox.pop3state + =back See L for documentation on them.