=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
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
=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.
+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.
-Default: none
+Messages without the (S)een Maildir flag are not considered for hiding.
+
+Default: none; only for L<public-inbox-watch(1)> users
=item publicinbox.nntpserver
; 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"]