X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=a5bc67fd63289f69f3fce69a8218db23371bd884;hb=ef6d335cb515996c2dd7cc0d9a188f9b041db425;hp=05b8481910cacf9250ac6d86790129810a14f91b;hpb=06a2418fd053c9a5b80217e74d1b47b8e1ca85e1;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 05b84819..a5bc67fd 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -62,38 +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. If specified multiple times in -public-inbox 1.5 or later, mail will be processed if it matches -any of the values. Only the last value was used in public-inbox -1.4 and earlier. - -Default: none; only for L users +See L =item publicinbox..listid @@ -113,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. @@ -139,6 +132,14 @@ 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 @@ -204,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 @@ -317,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 @@ -353,6 +342,22 @@ 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 + =back =head2 NAMED LIMITER (PSGI) @@ -365,7 +370,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 @@ -437,12 +442,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