From e4ebfd7f9679a2e28a6eb26db45eda772a55acda Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 15 Feb 2023 08:01:09 +0000 Subject: doc: WWW + cgi: favor -netd over -httpd -netd is strictly more powerful and a gateway drug for imapd/nntpd/pop3d instances :> --- Documentation/public-inbox.cgi.pod | 14 ++++++++------ lib/PublicInbox/WWW.pod | 16 +++++++++------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/Documentation/public-inbox.cgi.pod b/Documentation/public-inbox.cgi.pod index 71f8a6f5..0f93fa5a 100644 --- a/Documentation/public-inbox.cgi.pod +++ b/Documentation/public-inbox.cgi.pod @@ -4,7 +4,7 @@ public-inbox.cgi - CGI wrapper for PublicInbox::WWW =head1 SYNOPSIS -You generally want to run public-inbox-httpd, instead +You generally want to run public-inbox-netd or public-inbox-httpd, instead =head1 DESCRIPTION @@ -12,9 +12,10 @@ public-inbox.cgi provides a CGI interface wrapper on top of the PSGI/Plack L module. It is only provided for compatibility reasons and NOT recommended. -CGI with Perl is slow due to code loading overhead and web servers lack -the scheduling fairness of L for handling git -clones and streaming large mbox downloads. +CGI with Perl is slow due to code loading overhead and +web servers lack the scheduling fairness of L +and L for handling git clones and +streaming large mbox downloads. =head1 CONTACT @@ -25,10 +26,11 @@ L =head1 COPYRIGHT -Copyright 2019-2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L, L, L, +L, L, +L, L, diff --git a/lib/PublicInbox/WWW.pod b/lib/PublicInbox/WWW.pod index 9f6ba466..b55f010e 100644 --- a/lib/PublicInbox/WWW.pod +++ b/lib/PublicInbox/WWW.pod @@ -20,13 +20,14 @@ The PSGI web interface for public-inbox. Using this directly is not needed unless you wish to customize your public-inbox PSGI deployment or are using a PSGI server -other than L. +other than L (C<-netd>) / +L (C<-httpd>) -While this PSGI application works with all PSGI/Plack web +While this PSGI application should work with all PSGI/Plack web servers such as L, L or L; -PublicInbox::WWW takes advantage of currently-undocumented APIs -of L to improve fairness when serving -large responses for thread views and git clones. +PublicInbox::WWW takes advantage of internal APIs of C<-netd> +and C<-httpd> to improve fairness when serving large responses +for thread views, mbox downloads, and git clones. =head1 ENVIRONMENT @@ -47,10 +48,11 @@ and L +Copyright (C) all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L, L, L +L, L, L, +L -- cgit v1.2.3-24-ge0c7