diff options
author | Eric Wong <e@80x24.org> | 2022-08-01 21:24:43 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2022-08-02 19:20:11 +0000 |
commit | c38111d6f3877cf31d28b0a0339d063df0fa58f6 (patch) | |
tree | 8bf1d2c22d96a9bc3ca9c20b9c85eab46802c5be /Documentation/public-inbox-netd.pod | |
parent | a55a38db0276a8ce1a09392573af6e1305cbaba9 (diff) | |
download | public-inbox-c38111d6f3877cf31d28b0a0339d063df0fa58f6.tar.gz |
This allows memory savings by allowing multiple, completely unrelated-PSGI apps to run within the same process as IMAP, NNTP, and POP3.
Diffstat (limited to 'Documentation/public-inbox-netd.pod')
-rw-r--r-- | Documentation/public-inbox-netd.pod | 34 |
1 files changed, 25 insertions, 9 deletions
diff --git a/Documentation/public-inbox-netd.pod b/Documentation/public-inbox-netd.pod index dcf4d5b0..4dc27749 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<public-inbox-daemon(8)> 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<public-inbox-daemon(8)> implementations. The default configuration will never require write access to the directory where the public-inbox is stored, so it @@ -28,21 +29,34 @@ See common options in L<public-inbox-daemon(8)/OPTIONS>. =item --listen PROTO://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<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or C<nntps://>) may be specified to force a given protocol. +Environment variable overrides in effect during loading and +reloading (SIGHUP) can be specified as C<env.NAME=VALUE> for +all protocols. + +HTTP(S) listeners may also specify C<psgi=> to use a different +C<.psgi> file for each listener. + +C<err=/path/to/errors.log> may be used to isolate error/debug output +for a particular listener away from C<--stderr>. + +Non-HTTP(S) listeners may also specify C<out=> for logging to +C<stdout>. HTTP(S) users are encouraged to configure +L<Plack::Middleware::AccessLog> or +L<Plack::Middleware::AccessLog::Timed>, instead. + =item --cert /path/to/cert -The default TLS certificate for optional TLS support -if the C<cert> option is not given with C<--listen>. +See L<public-inbox-daemon(1)>. =item --key /path/to/key -The default private TLS certificate key for optional TLS support -if the C<key> option is not given with C<--listen>. The private -key may be concatenated into the path used by C<--cert>, in which case this -option is not needed. +See L<public-inbox-daemon(1)>. =back @@ -57,6 +71,8 @@ L<public-inbox-config(5)>. =item publicinbox.nntpserver +=item publicinbox.pop3state + =back See L<public-inbox-config(5)> for documentation on them. |