X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=1c5ba015e60c7f6cef4762e8e8d4aa575df4f876;hb=3c39f9c942a6975245fda878e9b957d8d3367662;hp=dae69987d0276415f0aad32de76d0ef6375d3931;hpb=89be7a1b89a60446fc0a385c5c1cfaeec2f92c88;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index dae69987..1c5ba015 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -17,13 +17,17 @@ all public-inboxes used by a particular user. =head2 EXAMPLE [publicinbox "test"] - mainrepo = /home/user/path/to/test.git + inboxdir = /home/user/path/to/test.git ; multiple addresses are supported address = test@example.com ; address = alternate@example.com url = http://example.com/test newsgroup = inbox.test + ; backwards compatibility with public-inbox pre-1.2.0, + ; "inboxdir" takes precedence over "mainrepo" + mainrepo = /home/user/path/to/test.git + =head2 VARIABLES =over 8 @@ -38,11 +42,14 @@ informational purposes. Default: none, required -=item publicinbox..mainrepo +=item publicinbox..inboxdir The absolute path to the directory which hosts the public-inbox. This must be specified once. +This was previously known as "mainrepo", which remains supported, +but "inboxdir" takes precedence. + Default: none, required =item publicinbox..url @@ -80,8 +87,29 @@ Default: none; only for L users [publicinbox "test"] watchheader = List-Id: +If specified, L will only process mail matching +the given header. Multiple values are not currently supported. + Default: none; only for L users +=item publicinbox..listid + +The L header without +angle brackets for L deliveries and +L. + +For public-inbox-watch users, this is a shortcut for specifying +C> + +For public-inbox-mda users, this may be used to avoid recipient +matching via C environment variable. + +This may be specified multiple times for merging multiple mailing +lists into a single public-inbox, only one C header +needs to match. + +Default: none + =item publicinbox..nntpmirror This may be the full NNTP URL of an independently-run mirror. @@ -91,6 +119,23 @@ C Default: none +=item publicinbox..indexlevel + +The indexing level for L + +C only requires L and provides all +NNTP functionality along with thread-awareness in the WWW +interface. + +C requires L to provide full-text +term search functionality in the WWW UI. + +C 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 + =item publicinbox..httpbackendmax If a digit, the maximum number of parallel @@ -188,6 +233,14 @@ be treated as the default value. Default: 25 +=item publicinbox..hide + +A comma-delimited list of listings to hide the inbox from. + +Valid values are currently C and C. + +Default: none + =item coderepo..dir The path to a git repository for "publicinbox..coderepo" @@ -215,7 +268,73 @@ A path to the C executable. The L interface can spawn cgit as a fallback if the publicinbox.cgitrc directive is configured. -Default: /usr/lib/cgit/cgit.cgi +Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi + +=item publicinbox.cgitdata + +A path to the data directory used by cgit for storing static files. +Typically guessed based the location of C (from +C, but may be overridden. + +Default: basename of C, /var/www/htdocs/cgit/ +or /usr/share/cgit/ + +=item publicinbox.mailEditor + +See L + +=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 + +=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: 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, regardless of domain. +Only use this if you're serving HTTP requests in a domain-agnostic manner. + +=item * 404 +- C 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 =back @@ -231,6 +350,10 @@ the default limiter. C keys may be set to enforce resource limits for a particular limiter. +Default named-limiters are prefixed with "-". Currently, +the "-cgit" named limiter is reserved for instances spawning +cgit via C + =over 8 =item publicinboxlimiter..max @@ -257,20 +380,20 @@ RLIMIT_CPU, and RLIMIT_DATA for you operating system. ; big inboxes which require lots of memory to clone: [publicinbox "big1"] - mainrepo = /path/to/big1 + inboxdir = /path/to/big1 address = big1@example.com httpbackendmax = big [publicinbox "big2"] - mainrepo = /path/to/big2 + inboxdir = /path/to/big2 address = big2@example.com httpbackendmax = big ; tiny inboxes which are easily cloned: [publicinbox "tiny1"] - mainrepo = /path/to/tiny1 + inboxdir = /path/to/tiny1 address = tiny1@example.com [publicinbox "tiny2"] - mainrepo = /path/to/tiny2 + inboxdir = /path/to/tiny2 address = tiny2@example.com [publicinboxlimiter "big"] @@ -302,11 +425,12 @@ and L =head1 COPYRIGHT -Copyright 2016-2018 all contributors L +Copyright 2016-2019 all contributors L License: AGPL-3.0+ L =head1 SEE ALSO L, L, L, -L, L +L, L, +L