about summary refs log tree commit homepage
path: root/Documentation/public-inbox.cgi.pod
diff options
authorEric Wong <e@80x24.org>2019-11-02 21:51:08 +0000
committerEric Wong <e@80x24.org>2019-11-03 00:06:56 +0000
commitfd5a1f0952c8c76e718a52748df8f3a96ffc5f34 (patch)
treed93150e844b309079d030270b05556cd8c2ec1d2 /Documentation/public-inbox.cgi.pod
parent3c19a5cc0d52a097210a50c99a01ac0cf7ccd2cc (diff)
Yet another case of documenting things which should NOT be used :>
Diffstat (limited to 'Documentation/public-inbox.cgi.pod')
1 files changed, 34 insertions, 0 deletions
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
+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/>
+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)>,