NAME
    public-inbox-config - public-inbox config file description

SYNOPSIS
    ~/.public-inbox/config

DESCRIPTION
    The public-inbox config file is parseable by git-config(1). This is a
    global configuration file for mapping/discovering all public-inboxes
    used by a particular user.

CONFIGURATION FILE
  EXAMPLE
            [publicinbox "test"]
                    mainrepo = /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

  VARIABLES
    publicinbox.<name>.address
            The email address of the public-inbox. May be specified more
            than once for merging multiple mailing lists (or migrating to
            new addresses). This must be specified at least once, the first
            value will be considered the primary address for informational
            purposes.

            Default: none, required

    publicinbox.<name>.mainrepo
            The absolute path to the git repository which hosts the
            public-inbox. This must be specified once.

            Default: none, required

    publicinbox.<name>.url
            The primary URL for hosting the HTTP/HTTPS archives. Additional
            HTTP/HTTPS URLs may be specified via "$GIT_DIR/cloneurl" as
            documented in gitweb(1)

            Default: none, optional

    publicinbox.<name>.newsgroup
            The NNTP group name for use with public-inbox-nntpd(8). This may
            be any newsgroup name with hierarchies delimited by '.'. For
            example, the newsgroup for <mailto:meta@public-inbox.org> is:
            "inbox.comp.mail.public-inbox.meta"

            Omitting this for the given inbox will prevent the group from
            being read by public-inbox-nntpd(1)

            Default: none, optional

    publicinbox.<name>.watch
            A location for public-inbox-watch(1) to watch. Currently, only
            "maildir:" paths are supported:

                    [publicinbox "test"]
                            watch = maildir:/path/to/maildirs/.INBOX.test/

            Default: none; only for public-inbox-watch(1) users

    publicinbox.<name>.watchheader
                    [publicinbox "test"]
                            watchheader = List-Id:<test.example.com>

            Default: none; only for public-inbox-watch(1) users

    publicinbox.<name>.nntpmirror
            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
            "nntp://news.gmane.org/gmane.mail.public-inbox.general"

            Default: none

    publicinboxwatch.spamcheck
            This may be set to "spamc" to enable the use of SpamAssassin
            spamc(1) for filtering spam before it is imported into git
            history. Other spam filtering backends may be supported in the
            future.

            Default: none

    publicinboxwatch.watchspam
            This may be set to "spamc" to enable the use of SpamAssassin
            spamc(1) for filtering spam before it is imported into git
            history. Other spam filtering backends may be supported in the
            future. This requires public-inbox-watch(1), but affects all
            configured public-inboxes in PI_CONFIG.

            Default: none

    publicinbox.nntpserver
            Set this to point to the address of the public-inbox-nntpd(1)
            instance. This is used to advertise the existence of the NNTP
            presnce in the PublicInbox::WWW HTML interface.

            Multiple values are allowed for servers with multiple addresses
            or mirrors.

            Default: none

    publicinbox.<name>.feedmax
            The size of an Atom feed for the inbox. If specified more than
            once, only the last value is used. Invalid values (<= 0) will be
            treated as the default value.

            Default: 25

ENVIRONMENT
    PI_CONFIG
            Used to override the default "~/.public-inbox/config" value.

CONTACT
    Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>

    The mail archives are hosted at <https://public-inbox.org/meta/> and
    <http://hjrcffqmbrq6wope.onion/meta/>

COPYRIGHT
    Copyright 2016 all contributors <mailto:meta@public-inbox.org>

    License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

SEE ALSO
    git(1), git-config(1), public-inbox-daemon(8), public-inbox-mda(1),
    public-inbox-watch(1)