3 public-inbox-config - public-inbox config file description
11 The public-inbox config file is parseable by L<git-config(1)>.
12 This is a global configuration file for mapping/discovering
13 all public-inboxes used by a particular user.
15 =head1 CONFIGURATION FILE
20 mainrepo = /home/user/path/to/test.git
21 ; multiple addresses are supported
22 address = test@example.com
23 ; address = alternate@example.com
24 url = http://example.com/test
25 newsgroup = inbox.test
31 =item publicinbox.<name>.address
33 The email address of the public-inbox. May be specified
34 more than once for merging multiple mailing lists (or migrating
35 to new addresses). This must be specified at least once,
36 the first value will be considered the primary address for
37 informational purposes.
39 Default: none, required
41 =item publicinbox.<name>.mainrepo
43 The absolute path to the git repository which hosts the
44 public-inbox. This must be specified once.
46 Default: none, required
48 =item publicinbox.<name>.url
50 The primary URL for hosting the HTTP/HTTPS archives.
51 Additional HTTP/HTTPS URLs may be specified via
52 C<$GIT_DIR/cloneurl> as documented in L<gitweb(1)>
54 Default: none, optional
56 =item publicinbox.<name>.newsgroup
58 The NNTP group name for use with L<public-inbox-nntpd(8)>. This
59 may be any newsgroup name with hierarchies delimited by '.'.
60 For example, the newsgroup for L<mailto:meta@public-inbox.org>
61 is: C<inbox.comp.mail.public-inbox.meta>
63 Omitting this for the given inbox will prevent the group from
64 being read by L<public-inbox-nntpd(1)>
66 Default: none, optional
68 =item publicinbox.<name>.watch
70 A location for L<public-inbox-watch(1)> to watch. Currently,
71 only C<maildir:> paths are supported:
74 watch = maildir:/path/to/maildirs/.INBOX.test/
76 Default: none; only for L<public-inbox-watch(1)> users
78 =item publicinbox.<name>.watchheader
81 watchheader = List-Id:<test.example.com>
83 Default: none; only for L<public-inbox-watch(1)> users
85 =item publicinbox.<name>.nntpmirror
87 This may be the full NNTP URL of an independently-run mirror.
88 For example, the https://public-inbox.org/meta/ inbox is
90 C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
94 =item publicinboxwatch.spamcheck
96 This may be set to C<spamc> to enable the use of SpamAssassin
97 L<spamc(1)> for filtering spam before it is imported into git
98 history. Other spam filtering backends may be supported in
103 =item publicinboxwatch.watchspam
105 This may be set to C<spamc> to enable the use of SpamAssassin
106 L<spamc(1)> for filtering spam before it is imported into git
107 history. Other spam filtering backends may be supported in
108 the future. This only affects L<public-inbox-watch(1)>.
112 =item publicinbox.nntpserver
114 Set this to point to the address of the L<public-inbox-nntpd(1)>
115 instance. This is used to advertise the existence of the NNTP
116 presnce in the L<PublicInbox::WWW> HTML interface.
118 Multiple values are allowed for servers with multiple
119 addresses or mirrors.
131 Used to override the default "~/.public-inbox/config" value.
137 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
139 The mail archives are hosted at L<https://public-inbox.org/meta/>
140 and L<http://hjrcffqmbrq6wope.onion/meta/>
144 Copyright 2016 all contributors L<mailto:meta@public-inbox.org>
146 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
150 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
151 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>