about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-05-05 23:28:02 +0000
committerEric Wong <e@80x24.org>2019-05-05 23:28:02 +0000
commite1ed79d1e99e2c58b3edb370e60904cf656dd823 (patch)
tree30607048c2f16a2610ad0774dcb959025357d8af /Documentation
parent632ed77815b8ad0f683abe78f32544c7ca7b9aed (diff)
parent7a3946ef122e8218c6ce3355d7f968562212d53b (diff)
downloadpublic-inbox-e1ed79d1e99e2c58b3edb370e60904cf656dd823.tar.gz
* origin/wwwlisting:
  www: support listing of inboxes
  start depending on Perl 5.10.1+
Diffstat (limited to 'Documentation')
-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 29150220..d44c8f30 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"
@@ -226,6 +234,35 @@ C<publicinbox.cgitbin>, but may be overridden.
 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
 or /usr/share/cgit/
 
+=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)