X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=05d9ca6266cd4ca3fd1b1fe4509c59455d43ab4a;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=1dfb926ebcacb6389c066faf6c1a6de93ce05438;hpb=6f5b7803c82c45105272802b818df684b87bd2ec;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 1dfb926e..05d9ca62 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -74,26 +74,11 @@ 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 @@ -204,26 +189,11 @@ 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. - -Messages without the (S)een Maildir flag are not considered for hiding. - -Default: none; only for L users +See L =item publicinbox.nntpserver @@ -317,9 +287,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 +322,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 +350,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 +422,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