doc: explain publicinbox.<name>.watchheader

[public-inbox.git] / Documentation / public-inbox-config.pod

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index a86132be0db1d45ea88098bdec8d1b5eef5b556c..8d545f7afa247339653b72ceb13183aa749fc70d 100644 (file)
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -80,6 +80,9 @@ Default: none; only for L<public-inbox-watch(1)> users
        [publicinbox "test"]
                watchheader = List-Id:<test.example.com>
 
+If specified, L<public-inbox-watch(1)> will only process mail matching
+the given header.  Multiple values are not currently supported.
+
 Default: none; only for L<public-inbox-watch(1)> users
 
 =item publicinbox.<name>.nntpmirror
@@ -91,6 +94,23 @@ C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
 
 Default: none
 
+=item publicinbox.<name>.indexlevel
+
+The indexing level for L<public-inbox-index(1)>
+
+C<basic> only requires L<DBD::SQLite(3pm)> and provides all
+NNTP functionality along with thread-awareness in the WWW
+interface.
+
+C<medium> requires L<Search::Xapian(3pm)> to provide full-text
+term search functionality in the WWW UI.
+
+C<full> also includes positional information used by Xapian to
+allow for searching for phrases using quoted text.
+(e.g. C<"looking for a complete sentence">)
+
+Default: C<full>
+
 =item publicinbox.<name>.httpbackendmax
 
 If a digit, the maximum number of parallel
@@ -192,7 +212,7 @@ Default: 25
 
 A comma-delimited list of listings to hide the inbox from.
 
-Valid values are currently "www".
+Valid values are currently C<www> and C<manifest>.
 
 Default: none
 
@@ -261,7 +281,35 @@ support showing cgit listing
 
 =back
 
-Default: 404
+Default: C<404>
+
+=item publicinbox.grokmanifest
+
+Controls the generation of a grokmirror-compatible gzipped JSON file
+at the top-level of the PSGI interface.  You generally do not need to
+change this from the default.
+
+Valid values are:
+
+=over 8
+
+=item * match=domain
+- Only include inboxes with URLs which belong to the domain of
+the HTTP request.  This is compatible with virtual hosting where
+several domains come from the same host.
+
+=item * all
+- All inboxes are present in C<manifest.js.gz>, regardless of domain.
+Only use this if you're serving HTTP requests in a domain-agnostic manner.
+
+=item * 404
+- C<manifest.js.gz> will only contain an empty JSON array.
+This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
+always contain all git repos used by the inbox at C<$INBOX_URL>
+
+=back
+
+Default: C<match=domain>
 
 =back
 
@@ -352,11 +400,12 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2016-2018 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2016-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<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
-L<public-inbox-mda(1)>, L<public-inbox-watch(1)>
+L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
+L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>