lib/PublicInbox/WWW.pod

   1 =head1 NAME
   2
   3 PublicInbox::WWW - PSGI interface for public-inbox
   4
   5 =head1 SYNOPSIS
   6
   7 In your .psgi file:
   8
   9         use PublicInbox::WWW;
  10
  11         my $www = PublicInbox::WWW->new;
  12         builder {
  13                 enable 'Head';
  14                 mount '/inboxes' => sub { $www->call(@_) };
  15         };
  16
  17 =head1 DESCRIPTION
  18
  19 The PSGI web interface for public-inbox.
  20
  21 Using this directly is not needed unless you wish to customize
  22 your public-inbox PSGI deployment or are using a PSGI server
  23 other than L<public-inbox-httpd(1)>.
  24
  25 While this PSGI application works with all PSGI/Plack web
  26 servers such as L<starman(1)>, L<starlet(1)> or L<twiggy(1)>;
  27 PublicInbox::WWW takes advantage of currently-undocumented APIs
  28 of L<public-inbox-httpd(1)> to improve fairness when serving
  29 large responses for thread views and git clones.
  30
  31 =head1 ENVIRONMENT
  32
  33 =over 8
  34
  35 =item PI_CONFIG
  36
  37 Used to override the default "~/.public-inbox/config" value.
  38
  39 =back
  40
  41 =head1 CONTACT
  42
  43 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  44
  45 The mail archives are hosted at L<https://public-inbox.org/meta/>
  46 and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  47
  48 =head1 COPYRIGHT
  49
  50 Copyright (C) 2016-2021 all contributors L<mailto:meta@public-inbox.org>
  51
  52 License: AGPL-3.0+ L<http://www.gnu.org/licenses/agpl-3.0.txt>
  53
  54 =head1 SEE ALSO
  55
  56 L<http://plackperl.org/>, L<Plack>, L<public-inbox-httpd(1)>