diff options
| -rw-r--r-- | Documentation/.gitignore | 1 | ||||
| -rw-r--r-- | Documentation/include.mk | 1 | ||||
| -rw-r--r-- | Documentation/public-inbox.cgi.pod | 34 | ||||
| -rw-r--r-- | MANIFEST | 1 |
4 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/.gitignore b/Documentation/.gitignore index 4d2ca22f..f26169ac 100644 --- a/Documentation/.gitignore +++ b/Documentation/.gitignore @@ -1,3 +1,4 @@ /public-inbox-*.txt +/public-inbox.cgi.txt /standards.txt /.x diff --git a/Documentation/include.mk b/Documentation/include.mk index fd2c95f2..e948778a 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -37,6 +37,7 @@ podtext = $(PODTEXT) $(PODTEXT_OPTS) m1 = m1 += public-inbox-compact m1 += public-inbox-convert +m1 += public-inbox.cgi m1 += public-inbox-edit m1 += public-inbox-httpd m1 += public-inbox-index diff --git a/Documentation/public-inbox.cgi.pod b/Documentation/public-inbox.cgi.pod new file mode 100644 index 00000000..01187d84 --- /dev/null +++ b/Documentation/public-inbox.cgi.pod @@ -0,0 +1,34 @@ +=head1 NAME + +public-inbox.cgi - CGI wrapper for PublicInbox::WWW + +=head1 SYNOPSIS + +You generally want to run public-inbox-httpd, instead + +=head1 DESCRIPTION + +public-inbox.cgi provides a CGI interface wrapper on top of the +PSGI/Plack L<PublicInbox::WWW> 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<public-inbox-httpd(1)> for handling git +clones and streaming large mbox downloads. + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2019 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<public-inbox-httpd(1)>, L<PublicInbox::WWW>, L<public-inbox-daemon(8)>, @@ -31,6 +31,7 @@ Documentation/public-inbox-v1-format.pod Documentation/public-inbox-v2-format.pod Documentation/public-inbox-watch.pod Documentation/public-inbox-xcpdb.pod +Documentation/public-inbox.cgi.pod Documentation/standards.perl Documentation/txt2pre HACKING |