about summary refs log tree commit
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-09-15 04:20:04 +0000
committerEric Wong <e@80x24.org>2019-09-15 06:27:15 +0000
commit9a6fe0aac9ef23537af6221568c28aa11a81bbb5 (patch)
treea323d120186e83a8de3d5ace4b33d5d43e3915ed
parent68b8b7924cfc445e8fcd8cc58d6628d8f377ac53 (diff)
downloadpublic-inbox-9a6fe0aac9ef23537af6221568c28aa11a81bbb5.tar.gz
It's a bit of an esoteric option, but maybe somebody out
there can find it useful.
-rw-r--r--Documentation/public-inbox-config.pod35
1 files changed, 32 insertions, 3 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index b86d2fe8..4e8ba4da 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -209,7 +209,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
 
@@ -278,7 +278,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
 
@@ -376,4 +404,5 @@ 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>