X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=43e54ed42d9d561e3f4a85729c9356a60b3f027a;hb=3ae2a4c3a8f22c0fe08c5c4c26919e311195c23e;hp=53926ef4f8aed567a4d9b80fd58b832208bf5f60;hpb=95bdac7f09c69036efed537a4d03d5bdd2ae4eb6;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 53926ef4..43e54ed4 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -62,35 +62,25 @@ Default: none, optional =item publicinbox..newsgroup -The NNTP group name for use with L. This -may be any newsgroup name with hierarchies delimited by '.'. +The NNTP group name for use with L. This +may be any newsgroup name with hierarchies delimited by C<.>. For example, the newsgroup for L is: C -Omitting this for the given inbox will prevent the group from -being read by L +It also configures the folder hierarchy used by L. + +Omitting this for a given inbox will prevent the inbox from +being served by L and/or L. Default: none, optional =item publicinbox..watch -A location for L to watch. Currently, -only C paths are supported: - - [publicinbox "test"] - watch = maildir:/path/to/maildirs/.INBOX.test/ - -Default: none; only for L users +See L =item publicinbox..watchheader - [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 +See L =item publicinbox..listid @@ -99,7 +89,7 @@ angle brackets for L deliveries and L. For public-inbox-watch users, this is a shortcut for specifying -C> +Cfoo.example.comE> For public-inbox-mda users, this may be used to avoid recipient matching via C environment variable. @@ -110,6 +100,12 @@ needs to match. Default: none +=item publicinbox..imapmirror + +This may be the full IMAP URL of an independently-run IMAP mirror. + +Default: none + =item publicinbox..nntpmirror This may be the full NNTP URL of an independently-run mirror. @@ -136,6 +132,18 @@ allow for searching for phrases using quoted text. Default: C +=item publicinbox..boost + +Control indexing order for L, with ties +broken by config file order. This only affects indexing and does +not affect messages which are already indexed. + +Default: C<0> + +=item publicinbox..indexSequentialShard + +See L + =item publicinbox..httpbackendmax If a digit, the maximum number of parallel @@ -197,35 +205,24 @@ Default: spamc =item publicinboxwatch.spamcheck -This may be set to C to enable the use of SpamAssassin -L for filtering spam before it is imported into git -history. Other spam filtering backends may be supported in -the future. - -This requires L, but affects all configured -public-inboxes in PI_CONFIG. - -Default: none +See L =item publicinboxwatch.watchspam -A Maildir to watch for confirmed spam messages to appear in. -Messages which appear in this folder with the (S)een Maildir flag -will be hidden from all configured inboxes based on Message-ID -and content matching. +See L -Messages without the (S)een Maildir flag are not considered for hiding. +=item publicinbox.imapserver -Default: none; only for L users +Set this to point to the hostname(s) of the L +instance. This is used to advertise the existence of the IMAP +endpoint in the L HTML interface. -=item publicinbox.nntpserver +Default: none -Set this to point to the hostname of the L -instance. This is used to advertise the existence of the NNTP -endpoint in the L HTML interface. +=item publicinbox.nntpserver -Multiple values are allowed for instances with multiple hostnames -or mirrors. +Same as C, but for the hostname(s) of the +L instance. Default: none @@ -287,6 +284,12 @@ or /usr/share/cgit/ See L +=item publicinbox.indexMaxSize +=item publicinbox.indexBatchSize +=item publicinbox.indexSequentialShard + +See L + =item publicinbox.wwwlisting Enable a HTML listing style when the root path of the URL '/' is accessed. @@ -304,9 +307,8 @@ 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 +=for comment +TODO support showing cgit listing =back @@ -340,6 +342,38 @@ always contain all git repos used by the inbox at C<$INBOX_URL> Default: C +=item publicinbox..obfuscate + +Whether to obfuscate email addresses in the L HTML +interface. + +Default: false + +=item publicinbox.noObfuscate + +A space-delimited list of well-known addresses and domains that should +not be obfuscated when C is true (e.g., +C and C<@example.com>). This may be specified +more than once, in which case the values are merged. + +Default: none + +=item extindex..topdir + +The directory of an external index. See +L for more details. + +=item extindex..url + +Identical to LnameE.url>, but for +external indices + +=item extindex..coderepo + +Identical to LnameE.coderepo>, but for +external indices. Code repos may be freely associated with +any number of public inboxes and external indices. + =back =head2 NAMED LIMITER (PSGI) @@ -352,7 +386,7 @@ limiter with a low max value; while smaller inboxes can use the default limiter. C keys may be set to enforce resource limits for -a particular limiter. +a particular limiter (L is required). Default named-limiters are prefixed with "-". Currently, the "-cgit" named limiter is reserved for instances spawning @@ -424,12 +458,12 @@ Used to override the default "~/.public-inbox/config" value. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2016-2020 all contributors L +Copyright 2016-2021 all contributors L License: AGPL-3.0+ L