about summary refs log tree commit homepage
path: root/Documentation/public-inbox-config.pod
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-04-18 08:25:56 +0000
committerEric Wong <e@80x24.org>2019-04-19 23:57:21 +0000
commit7a3946ef122e8218c6ce3355d7f968562212d53b (patch)
tree76b5011e71edbb37494bf1dcaa4db04f7d9882da /Documentation/public-inbox-config.pod
parentf3b60bf095846ce9290b94a7b1d700ed7bf0f316 (diff)
downloadpublic-inbox-7a3946ef122e8218c6ce3355d7f968562212d53b.tar.gz
We will still return a 404 by default to '/' for compatibility
with users of Plack::App::Cascade or similar.  Inboxes are
sorted by modification times to help users detect activity
(similar to the /$INBOX/ topic view).

New configuration options:

* publicinbox.wwwlisting - configure the listing type
* publicinbox.<name>.hide - hide a particular inbox from the listing

See changes to public-inbox-config.pod for full descriptions
of the new options.

Requested-by: Leah Neukirchen <leah@vuxu.org>
  https://public-inbox.org/meta/871sdfzy80.fsf@gmail.com/
Diffstat (limited to 'Documentation/public-inbox-config.pod')
-rw-r--r--Documentation/public-inbox-config.pod37
1 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index f894eb3d..17b8bac7 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -188,6 +188,14 @@ be treated as the default value.
 
 Default: 25
 
+=item publicinbox.<name>.hide
+
+A comma-delimited list of listings to hide the inbox from.
+
+Valid values are currently "www".
+
+Default: none
+
 =item coderepo.<nick>.dir
 
 The path to a git repository for "publicinbox.<name>.coderepo"
@@ -217,6 +225,35 @@ directive is configured.
 
 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
 
+=item publicinbox.wwwlisting
+
+Enable a HTML listing style when the root path of the URL '/' is accessed.
+Valid values are:
+
+=over 8
+
+=item all
+
+Show all inboxes
+
+=item 404
+
+Return a 404 page.  This is useful to allow customization with
+L<Plack::App::Cascade(3pm)>
+
+=item match=domain
+
+Only show inboxes with URLs which belong to the domain of the HTTP
+request
+
+=for TODO comment
+
+support showing cgit listing
+
+=back
+
+Default: 404
+
 =back
 
 =head2 NAMED LIMITER (PSGI)