ds|http|nntp: simplify {wbuf} population

[public-inbox.git] / Documentation / public-inbox-config.pod

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 8d545f7afa247339653b72ceb13183aa749fc70d..1825ce05546fb3895962b1000b8e9a224a120eb9 100644 (file)
--- 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"]
 =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
 
                ; 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
 =head2 VARIABLES
 
 =over 8


@@ -38,11 +42,14 @@ informational purposes.
 
 Default: none, required
 
 
 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.
 
 
 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
 Default: none, required
 
 =item publicinbox.<name>.url


@@ -85,6 +92,24 @@ the given header.  Multiple values are not currently supported.
 
 Default: none; only for L<public-inbox-watch(1)> users
 
 
 Default: none; only for L<public-inbox-watch(1)> users
 

+=item publicinbox.<name>.listid
+
+The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
+angle brackets for L<public-inbox-mda(1)> deliveries and
+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>>
+
+For public-inbox-mda users, this may be used to avoid recipient
+matching via C<ORIGINAL_RECIPIENT> environment variable.
+
+This may be specified multiple times for merging multiple mailing
+lists into a single public-inbox, only one C<List-Id> header
+needs to match.
+
+Default: none
+

 =item publicinbox.<name>.nntpmirror
 
 This may be the full NNTP URL of an independently-run mirror.
 =item publicinbox.<name>.nntpmirror
 
 This may be the full NNTP URL of an independently-run mirror.


@@ -142,7 +167,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
 
 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.
 
 Mirrors of existing centralized mailing lists may use ":list"
 here to redirect mail only to the configured inbox address.


@@ -177,17 +202,21 @@ L<spamc(1)> for filtering spam before it is imported into git
 history.  Other spam filtering backends may be supported in
 the future.
 
 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
 
 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
 
 
 =item publicinbox.nntpserver
 


@@ -355,20 +384,20 @@ RLIMIT_CPU, and RLIMIT_DATA for you operating system.
 
        ; big inboxes which require lots of memory to clone:
        [publicinbox "big1"]
 
        ; 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"]
                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"]
                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"]
                address = tiny1@example.com
        [publicinbox "tiny2"]

-               mainrepo = /path/to/tiny2
+               inboxdir = /path/to/tiny2

                address = tiny2@example.com
 
        [publicinboxlimiter "big"]
                address = tiny2@example.com
 
        [publicinboxlimiter "big"]