X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=05d9ca6266cd4ca3fd1b1fe4509c59455d43ab4a;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=1c5ba015e60c7f6cef4762e8e8d4aa575df4f876;hpb=fece7fca6aeac74410a813cffcb0da338017d0ed;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 1c5ba015..05d9ca62 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -63,7 +63,7 @@ Default: none, optional =item publicinbox..newsgroup The NNTP group name for use with L. This -may be any newsgroup name with hierarchies delimited by '.'. +may be any newsgroup name with hierarchies delimited by C<.>. For example, the newsgroup for L is: C @@ -74,23 +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. Multiple values are not currently supported. - -Default: none; only for L users +See L =item publicinbox..listid @@ -99,7 +87,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. @@ -115,7 +103,7 @@ Default: none This may be the full NNTP URL of an independently-run mirror. For example, the https://public-inbox.org/meta/ inbox is mirrored by Gmane at -C +C Default: none @@ -136,6 +124,10 @@ allow for searching for phrases using quoted text. Default: C +=item publicinbox..indexSequentialShard + +See L + =item publicinbox..httpbackendmax If a digit, the maximum number of parallel @@ -167,7 +159,7 @@ interface are displayed. A list of comma-delimited email addresses may be specified. This can be useful for dedicated inboxes for bot emails, but -discussion happens on a seperate mailing list/inbox. +discussion happens on a separate mailing list/inbox. Mirrors of existing centralized mailing lists may use ":list" here to redirect mail only to the configured inbox address. @@ -197,31 +189,20 @@ 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. - -Default: none +See L =item publicinboxwatch.watchspam -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 publicinbox.nntpserver -Set this to point to the address of the L +Set this to point to the hostname of the L instance. This is used to advertise the existence of the NNTP -presnce in the L HTML interface. +endpoint in the L HTML interface. -Multiple values are allowed for servers with multiple -addresses or mirrors. +Multiple values are allowed for instances with multiple hostnames +or mirrors. Default: none @@ -283,6 +264,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. @@ -300,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 @@ -336,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) @@ -348,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 @@ -420,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-2019 all contributors L +Copyright 2016-2021 all contributors L License: AGPL-3.0+ L