=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
Default: none, required
-=item publicinbox.<name>.mainrepo
+=item publicinbox.<name>.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.<name>.url
=item publicinbox.<name>.newsgroup
The NNTP group name for use with L<public-inbox-nntpd(8)>. 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<mailto:meta@public-inbox.org>
is: C<inbox.comp.mail.public-inbox.meta>
=item publicinbox.<name>.watch
-A location for L<public-inbox-watch(1)> to watch. Currently,
-only C<maildir:> paths are supported:
-
- [publicinbox "test"]
- watch = maildir:/path/to/maildirs/.INBOX.test/
-
-Default: none; only for L<public-inbox-watch(1)> users
+See L<public-inbox-watch(1)>
=item publicinbox.<name>.watchheader
- [publicinbox "test"]
- watchheader = List-Id:<test.example.com>
-
-If specified, L<public-inbox-watch(1)> will only process mail matching
-the given header. Multiple values are not currently supported.
-
-Default: none; only for L<public-inbox-watch(1)> users
+See L<public-inbox-watch(1)>
=item publicinbox.<name>.listid
L<public-inbox-watch(1)>.
For public-inbox-watch users, this is a shortcut for specifying
-C<publicinbox.$NAME.watchheader=List-Id:<foo.example.com>>
+C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
For public-inbox-mda users, this may be used to avoid recipient
matching via C<ORIGINAL_RECIPIENT> environment variable.
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<nntp://news.gmane.org/gmane.mail.public-inbox.general>
+C<nntp://news.gmane.io/gmane.mail.public-inbox.general>
Default: none
Default: C<full>
+=item publicinbox.<name>.indexSequentialShard
+
+See L<public-inbox-index(1)/publicInbox.indexSequentialShard>
+
=item publicinbox.<name>.httpbackendmax
If a digit, the maximum number of parallel
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.
=item publicinboxwatch.spamcheck
-This may be set to C<spamc> to enable the use of SpamAssassin
-L<spamc(1)> for filtering spam before it is imported into git
-history. Other spam filtering backends may be supported in
-the future.
-
-Default: none
+See L<public-inbox-watch(1)>
=item publicinboxwatch.watchspam
-This may be set to C<spamc> to enable the use of SpamAssassin
-L<spamc(1)> for filtering spam before it is imported into git
-history. Other spam filtering backends may be supported in
-the future. This requires L<public-inbox-watch(1)>, but affects
-all configured public-inboxes in PI_CONFIG.
-
-Default: none
+See L<public-inbox-watch(1)>
=item publicinbox.nntpserver
-Set this to point to the
address of the L<public-inbox-nntpd(1)>
+Set this to point to the
hostname of the L<public-inbox-nntpd(1)>
instance. This is used to advertise the existence of the NNTP
-
presnce in the L<PublicInbox::WWW> HTML interface.
+
endpoint in the L<PublicInbox::WWW> 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
See L<public-inbox-edit(1)>
+=item publicinbox.indexMaxSize
+=item publicinbox.indexBatchSize
+=item publicinbox.indexSequentialShard
+
+See L<public-inbox-index(1)>
+
=item publicinbox.wwwlisting
Enable a HTML listing style when the root path of the URL '/' is accessed.
; 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"]
=head1 COPYRIGHT
-Copyright 2016-2019 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>