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 inboxdir = /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
27 ; backwards compatibility with public-inbox pre-1.2.0,
28 ; "inboxdir" takes precedence over "mainrepo"
29 mainrepo = /home/user/path/to/test.git
35 =item publicinbox.<name>.address
37 The email address of the public-inbox. May be specified
38 more than once for merging multiple mailing lists (or migrating
39 to new addresses). This must be specified at least once,
40 the first value will be considered the primary address for
41 informational purposes.
43 Default: none, required
45 =item publicinbox.<name>.inboxdir
47 The absolute path to the directory which hosts the
48 public-inbox. This must be specified once.
50 This was previously known as "mainrepo", which remains supported,
51 but "inboxdir" takes precedence.
53 Default: none, required
55 =item publicinbox.<name>.url
57 The primary URL for hosting the HTTP/HTTPS archives.
58 Additional HTTP/HTTPS URLs may be specified via
59 C<$GIT_DIR/cloneurl> as documented in L<gitweb(1)>
61 Default: none, optional
63 =item publicinbox.<name>.newsgroup
65 The NNTP group name for use with L<public-inbox-nntpd(8)>. This
66 may be any newsgroup name with hierarchies delimited by '.'.
67 For example, the newsgroup for L<mailto:meta@public-inbox.org>
68 is: C<inbox.comp.mail.public-inbox.meta>
70 Omitting this for the given inbox will prevent the group from
71 being read by L<public-inbox-nntpd(1)>
73 Default: none, optional
75 =item publicinbox.<name>.watch
77 A location for L<public-inbox-watch(1)> to watch. Currently,
78 only C<maildir:> paths are supported:
81 watch = maildir:/path/to/maildirs/.INBOX.test/
83 Default: none; only for L<public-inbox-watch(1)> users
85 =item publicinbox.<name>.watchheader
88 watchheader = List-Id:<test.example.com>
90 If specified, L<public-inbox-watch(1)> will only process mail
91 matching the given header. If specified multiple times in
92 public-inbox 1.5 or later, mail will be processed if it matches
93 any of the values. Only the last value was used in public-inbox
96 Default: none; only for L<public-inbox-watch(1)> users
98 =item publicinbox.<name>.listid
100 The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
101 angle brackets for L<public-inbox-mda(1)> deliveries and
102 L<public-inbox-watch(1)>.
104 For public-inbox-watch users, this is a shortcut for specifying
105 C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
107 For public-inbox-mda users, this may be used to avoid recipient
108 matching via C<ORIGINAL_RECIPIENT> environment variable.
110 This may be specified multiple times for merging multiple mailing
111 lists into a single public-inbox, only one C<List-Id> header
116 =item publicinbox.<name>.nntpmirror
118 This may be the full NNTP URL of an independently-run mirror.
119 For example, the https://public-inbox.org/meta/ inbox is
121 C<nntp://news.gmane.io/gmane.mail.public-inbox.general>
125 =item publicinbox.<name>.indexlevel
127 The indexing level for L<public-inbox-index(1)>
129 C<basic> only requires L<DBD::SQLite(3pm)> and provides all
130 NNTP functionality along with thread-awareness in the WWW
133 C<medium> requires L<Search::Xapian(3pm)> to provide full-text
134 term search functionality in the WWW UI.
136 C<full> also includes positional information used by Xapian to
137 allow for searching for phrases using quoted text.
138 (e.g. C<"looking for a complete sentence">)
142 =item publicinbox.<name>.httpbackendmax
144 If a digit, the maximum number of parallel
145 L<git-http-backend(1)> processes to allow for cloning this
148 If an alphanumeric value starting with a lowercase alphabetic
149 character is specified, the inbox will use a L</NAMED LIMITER>
150 which can be shared by multiple inboxes.
152 Default: 32 (using a default limiter shared by all inboxes)
154 =item publicinbox.<name>.coderepo
156 The nickname of a "coderepo" section associated with the inbox.
157 May be specified more than once for M:N mapping of code repos to
158 inboxes. If enabled, diff hunk headers in patch emails will
159 link to the line numbers of blobs.
163 =item publicinbox.<name>.replyto
165 May be used to control how reply instructions in the PSGI
166 interface are displayed.
168 ":none=dead inbox" may be specified to denote an inactive list
169 ("dead inbox" may be replaced with another phrase).
171 A list of comma-delimited email addresses may be specified.
172 This can be useful for dedicated inboxes for bot emails, but
173 discussion happens on a separate mailing list/inbox.
175 Mirrors of existing centralized mailing lists may use ":list"
176 here to redirect mail only to the configured inbox address.
177 The use of ":list" is discouraged for new mailing lists, as it
178 leads to centralization.
182 =item publicinbox.css
184 The local path name of a CSS file for the PSGI web interface.
185 May contain the attributes "media", "title" and "href" which match
186 the associated attributes of the HTML <style> tag.
187 "href" may be specified to point to the URL of an remote CSS file
188 and the path may be "/dev/null" or any empty file.
189 Multiple files may be specified and will be included in the
192 =item publicinboxmda.spamcheck
194 This may be set to C<none> to disable the use of SpamAssassin
195 L<spamc(1)> for filtering spam before it is imported into git
196 history. Other spam filtering backends may be supported in
201 =item publicinboxwatch.spamcheck
203 This may be set to C<spamc> to enable the use of SpamAssassin
204 L<spamc(1)> for filtering spam before it is imported into git
205 history. Other spam filtering backends may be supported in
208 This requires L<public-inbox-watch(1)>, but affects all configured
209 public-inboxes in PI_CONFIG.
213 =item publicinboxwatch.watchspam
215 A Maildir to watch for confirmed spam messages to appear in.
216 Messages which appear in this folder with the (S)een Maildir flag
217 will be hidden from all configured inboxes based on Message-ID
218 and content matching.
220 Messages without the (S)een Maildir flag are not considered for hiding.
222 Default: none; only for L<public-inbox-watch(1)> users
224 =item publicinbox.nntpserver
226 Set this to point to the hostname of the L<public-inbox-nntpd(1)>
227 instance. This is used to advertise the existence of the NNTP
228 endpoint in the L<PublicInbox::WWW> HTML interface.
230 Multiple values are allowed for instances with multiple hostnames
235 =item publicinbox.<name>.feedmax
237 The size of an Atom feed for the inbox. If specified more than
238 once, only the last value is used. Invalid values (<= 0) will
239 be treated as the default value.
243 =item publicinbox.<name>.hide
245 A comma-delimited list of listings to hide the inbox from.
247 Valid values are currently C<www> and C<manifest>.
251 =item coderepo.<nick>.dir
253 The path to a git repository for "publicinbox.<name>.coderepo"
255 =item coderepo.<nick>.cgitUrl
257 The URL of the cgit instance associated with the coderepo.
261 =item publicinbox.cgitrc
263 A path to a L<cgitrc(5)> file. "repo.url" directives in the cgitrc
264 will be mapped to the nickname of a coderepo (without trailing slash),
265 and "repo.path" directives map to "coderepo.<nick>.dir".
266 Use of this directive allows admins of existing cgit installations
267 to skip declaring coderepo sections and map inboxes directly to
268 code repositories known to cgit.
270 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
272 =item publicinbox.cgitbin
274 A path to the C<cgit.cgi> executable. The L<PublicInbox::WWW>
275 interface can spawn cgit as a fallback if the publicinbox.cgitrc
276 directive is configured.
278 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
280 =item publicinbox.cgitdata
282 A path to the data directory used by cgit for storing static files.
283 Typically guessed based the location of C<cgit.cgi> (from
284 C<publicinbox.cgitbin>, but may be overridden.
286 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
289 =item publicinbox.mailEditor
291 See L<public-inbox-edit(1)>
293 =item publicinbox.indexMaxSize
295 See L<public-inbox-index(1)>
297 =item publicinbox.wwwlisting
299 Enable a HTML listing style when the root path of the URL '/' is accessed.
308 - Return a 404 page. This is useful to allow customization with
309 L<Plack::App::Cascade(3pm)>
312 - Only show inboxes with URLs which belong to the domain of the HTTP request
316 support showing cgit listing
322 =item publicinbox.grokmanifest
324 Controls the generation of a grokmirror-compatible gzipped JSON file
325 at the top-level of the PSGI interface. You generally do not need to
326 change this from the default.
333 - Only include inboxes with URLs which belong to the domain of
334 the HTTP request. This is compatible with virtual hosting where
335 several domains come from the same host.
338 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
339 Only use this if you're serving HTTP requests in a domain-agnostic manner.
342 - C<manifest.js.gz> will only contain an empty JSON array.
343 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
344 always contain all git repos used by the inbox at C<$INBOX_URL>
348 Default: C<match=domain>
352 =head2 NAMED LIMITER (PSGI)
354 Named limiters are useful for preventing large inboxes from
355 monopolizing (or overloading) the server. Since serving git
356 clones (via L<git-http-backend(1)> can be memory-intensive for
357 large inboxes, it makes sense to put large inboxes on a named
358 limiter with a low max value; while smaller inboxes can use
361 C<RLIMIT_*> keys may be set to enforce resource limits for
362 a particular limiter.
364 Default named-limiters are prefixed with "-". Currently,
365 the "-cgit" named limiter is reserved for instances spawning
366 cgit via C<publicinbox.cgitrc>
370 =item publicinboxlimiter.<name>.max
372 The maximum number of parallel processes for the given limiter.
374 =item publicinboxlimiter.<name>.rlimitCore
376 =item publicinboxlimiter.<name>.rlimitCPU
378 =item publicinboxlimiter.<name>.rlimitData
380 The maximum core size, CPU time, or data size processes run with the
381 given limiter will use. This may be comma-separated to distinguish
382 soft and hard limits. The word "INFINITY" is accepted as the
383 RLIM_INFINITY constant (if supported by your OS).
385 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
386 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
390 =head3 EXAMPLE WITH NAMED LIMITERS
392 ; big inboxes which require lots of memory to clone:
394 inboxdir = /path/to/big1
395 address = big1@example.com
398 inboxdir = /path/to/big2
399 address = big2@example.com
402 ; tiny inboxes which are easily cloned:
403 [publicinbox "tiny1"]
404 inboxdir = /path/to/tiny1
405 address = tiny1@example.com
406 [publicinbox "tiny2"]
407 inboxdir = /path/to/tiny2
408 address = tiny2@example.com
410 [publicinboxlimiter "big"]
413 In the above example, the "big1" and "big2" are limited to four
414 parallel L<git-http-backend(1)> processes between them.
416 However, "tiny1" and "tiny2" will share the default limiter
417 which means there can be 32 L<git-http-backend(1)> processes
426 Used to override the default "~/.public-inbox/config" value.
432 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
434 The mail archives are hosted at L<https://public-inbox.org/meta/>
435 and L<http://hjrcffqmbrq6wope.onion/meta/>
439 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
441 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
445 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
446 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
447 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>