user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
* [PATCH] doc: update config manpage for "publicinbox.grokmanifest"
@ 2019-09-15  4:20 Eric Wong
  0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2019-09-15  4:20 UTC (permalink / raw)
  To: meta

It's a bit of an esoteric option, but maybe somebody out
there can find it useful.
 Documentation/public-inbox-config.pod | 35 ++++++++++++++++++++++++---
 1 file 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
-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>
+Default: C<match=domain>
@@ -376,4 +404,5 @@ License: AGPL-3.0+ L<>
 =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)>,

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2019-09-15  4:20 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-09-15  4:20 [PATCH] doc: update config manpage for "publicinbox.grokmanifest" Eric Wong

Code repositories for project(s) associated with this public inbox

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).