X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=a5bc67fd63289f69f3fce69a8218db23371bd884;hb=a1d11ab624367884f3cff76c13aba85be3a89e45;hp=36d6bff23dc24731cd1751669a911e7a47df0784;hpb=560f9442d058925dd3a8171e8739826768188288;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 36d6bff2..a5bc67fd 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -62,13 +62,15 @@ Default: none, optional =item publicinbox..newsgroup -The NNTP group name for use with L. This +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 @@ -98,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. @@ -124,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 @@ -195,14 +211,18 @@ See L See L -=item publicinbox.nntpserver +=item publicinbox.imapserver -Set this to point to the hostname of the L -instance. This is used to advertise the existence of the NNTP +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. -Multiple values are allowed for instances with multiple hostnames -or mirrors. +Default: none + +=item publicinbox.nntpserver + +Same as C, but for the hostname(s) of the +L instance. Default: none @@ -422,8 +442,8 @@ 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