X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=ed99b188beb198a470d52ba179f1f40448261e57;hb=refs%2Fheads%2Fmaster;hp=f3b6c8b7a28f1c1f06a5eb3eb27cde8a26d83998;hpb=fb8e7dbd1b711d25d1033c3f5f540ce47f6c0849;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index f3b6c8b7..d175d2d7 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -62,36 +62,27 @@ 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 +as well as L + +Omitting this for a given inbox will prevent the inbox from +being served by L, +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, mail will be processed -if it matches any of the values. - -Default: none; only for L users +See L =item publicinbox..listid @@ -111,6 +102,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. @@ -137,6 +134,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 @@ -198,38 +207,38 @@ 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. + +Default: none =item publicinbox.nntpserver -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. +Same as C, but for the hostname(s) of the +L instance. + +Default: none -Multiple values are allowed for instances with multiple hostnames -or mirrors. +=item publicinbox.pop3server + +Same as C, but for the hostname(s) of the +L instance. Default: none +=item publicinbox.pop3state + +See L + =item publicinbox..feedmax The size of an Atom feed for the inbox. If specified more than @@ -256,6 +265,10 @@ The URL of the cgit instance associated with the coderepo. Default: none +=item coderepo.snapshots + +See C in L + =item publicinbox.cgitrc A path to a L file. "repo.url" directives in the cgitrc @@ -284,11 +297,39 @@ C, but may be overridden. Default: basename of C, /var/www/htdocs/cgit/ or /usr/share/cgit/ +=item publicinbox.cgit + +Controls whether or not and how C is used for serving coderepos. +New in public-inbox 2.0.0 (PENDING). + +=over 8 + +=item * first + +Try using C as the first choice, this is the default. + +=item * fallback + +Fall back to using C only if our native, inbox-aware +git code repository viewer doesn't recognized the URL. + +=item * rewrite + +Rewrite C URLs for our native, inbox-aware code repository viewer. +This implies C for URLs the native viewer does not recognize. + +=back + +Default: C (C will be used iff C +is set and the C binary exists). + =item publicinbox.mailEditor See L =item publicinbox.indexMaxSize +=item publicinbox.indexBatchSize +=item publicinbox.indexSequentialShard See L @@ -309,9 +350,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 @@ -345,6 +385,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) @@ -357,7 +429,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 @@ -429,12 +501,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 all contributors L License: AGPL-3.0+ L