about summary refs log tree commit homepage
path: root/lib/PublicInbox/WWW.pod
blob: bbfd9082d5ea319587c48e60dde11f6619431c70 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
=head1 NAME

PublicInbox::WWW - PSGI interface for public-inbox

=head1 SYNOPSIS

In your .psgi file:

	use PublicInbox::WWW;

	my $www = PublicInbox::WWW->new;
	builder {
		enable 'Head';
		mount '/inboxes' => sub { $www->call(@_) };
	};

=head1 DESCRIPTION

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<public-inbox-httpd(1)>.

While this PSGI application works with all PSGI/Plack web
servers such as L<starman(1)>, L<starlet(1)> or L<twiggy(1)>;
PublicInbox::WWW takes advantage of currently-undocumented APIs
of L<public-inbox-httpd(1)> to improve fairness when serving
large responses for thread views and git clones.

=head1 ENVIRONMENT

=over 8

=item PI_CONFIG

Used to override the default "~/.public-inbox/config" value.

=back

=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 (C) 2016-2019 all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<http://www.gnu.org/licenses/agpl-3.0.txt>

=head1 SEE ALSO

L<http://plackperl.org/>, L<Plack>, L<public-inbox-httpd(1)>