X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=2d845f16ba76c10c27f29e85f9d8e16e476029f5;hb=f9b93b95ce1de27e0427e4bfeca0712ad681b064;hp=6a9739f71433c85ac8bba39ea8e0a0a11b0de5a0;hpb=356e1db5135802ed468719dfcd1f1c3f9dba9fff;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 6a9739f7..2d845f16 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -17,13 +17,17 @@ all public-inboxes used by a particular user. =head2 EXAMPLE [publicinbox "test"] - mainrepo = /home/user/path/to/test.git + inboxdir = /home/user/path/to/test.git ; multiple addresses are supported address = test@example.com ; address = alternate@example.com url = http://example.com/test newsgroup = inbox.test + ; backwards compatibility with public-inbox pre-1.2.0, + ; "inboxdir" takes precedence over "mainrepo" + mainrepo = /home/user/path/to/test.git + =head2 VARIABLES =over 8 @@ -38,11 +42,14 @@ informational purposes. Default: none, required -=item publicinbox..mainrepo +=item publicinbox..inboxdir The absolute path to the directory which hosts the public-inbox. This must be specified once. +This was previously known as "mainrepo", which remains supported, +but "inboxdir" takes precedence. + Default: none, required =item publicinbox..url @@ -56,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 @@ -67,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 @@ -92,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. @@ -108,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 @@ -129,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 @@ -160,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. @@ -190,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 @@ -276,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. @@ -373,20 +367,20 @@ RLIMIT_CPU, and RLIMIT_DATA for you operating system. ; big inboxes which require lots of memory to clone: [publicinbox "big1"] - mainrepo = /path/to/big1 + inboxdir = /path/to/big1 address = big1@example.com httpbackendmax = big [publicinbox "big2"] - mainrepo = /path/to/big2 + inboxdir = /path/to/big2 address = big2@example.com httpbackendmax = big ; tiny inboxes which are easily cloned: [publicinbox "tiny1"] - mainrepo = /path/to/tiny1 + inboxdir = /path/to/tiny1 address = tiny1@example.com [publicinbox "tiny2"] - mainrepo = /path/to/tiny2 + inboxdir = /path/to/tiny2 address = tiny2@example.com [publicinboxlimiter "big"] @@ -418,7 +412,7 @@ and L =head1 COPYRIGHT -Copyright 2016-2019 all contributors L +Copyright 2016-2020 all contributors L License: AGPL-3.0+ L