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(1)>. This
66 may be any newsgroup name with hierarchies delimited by C<.>.
67 For example, the newsgroup for L<mailto:meta@public-inbox.org>
68 is: C<inbox.comp.mail.public-inbox.meta>
70 It also configures the folder hierarchy used by L<public-inbox-imapd(1)>
71 as well as L<public-inbox-pop3d(1)>
73 Omitting this for a given inbox will prevent the inbox from
74 being served by L<public-inbox-nntpd(1)>,
75 L<public-inbox-imapd(1)>, and/or L<public-inbox-pop3d(1)>
77 Default: none, optional
79 =item publicinbox.<name>.watch
81 See L<public-inbox-watch(1)>
83 =item publicinbox.<name>.watchheader
85 See L<public-inbox-watch(1)>
87 =item publicinbox.<name>.listid
89 The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
90 angle brackets for L<public-inbox-mda(1)> deliveries and
91 L<public-inbox-watch(1)>.
93 For public-inbox-watch users, this is a shortcut for specifying
94 C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
96 For public-inbox-mda users, this may be used to avoid recipient
97 matching via C<ORIGINAL_RECIPIENT> environment variable.
99 This may be specified multiple times for merging multiple mailing
100 lists into a single public-inbox, only one C<List-Id> header
105 =item publicinbox.<name>.imapmirror
107 This may be the full IMAP URL of an independently-run IMAP mirror.
111 =item publicinbox.<name>.nntpmirror
113 This may be the full NNTP URL of an independently-run mirror.
114 For example, the https://public-inbox.org/meta/ inbox is
116 C<nntp://news.gmane.io/gmane.mail.public-inbox.general>
120 =item publicinbox.<name>.indexlevel
122 The indexing level for L<public-inbox-index(1)>
124 C<basic> only requires L<DBD::SQLite(3pm)> and provides all
125 NNTP functionality along with thread-awareness in the WWW
128 C<medium> requires L<Search::Xapian(3pm)> to provide full-text
129 term search functionality in the WWW UI.
131 C<full> also includes positional information used by Xapian to
132 allow for searching for phrases using quoted text.
133 (e.g. C<"looking for a complete sentence">)
137 =item publicinbox.<name>.boost
139 Control indexing order for L<public-inbox-extindex(1)>, with ties
140 broken by config file order. This only affects indexing and does
141 not affect messages which are already indexed.
145 =item publicinbox.<name>.indexSequentialShard
147 See L<public-inbox-index(1)/publicInbox.indexSequentialShard>
149 =item publicinbox.<name>.httpbackendmax
151 If a digit, the maximum number of parallel
152 L<git-http-backend(1)> processes to allow for cloning this
155 If an alphanumeric value starting with a lowercase alphabetic
156 character is specified, the inbox will use a L</NAMED LIMITER>
157 which can be shared by multiple inboxes.
159 Default: 32 (using a default limiter shared by all inboxes)
161 =item publicinbox.<name>.coderepo
163 The nickname of a "coderepo" section associated with the inbox.
164 May be specified more than once for M:N mapping of code repos to
165 inboxes. If enabled, diff hunk headers in patch emails will
166 link to the line numbers of blobs.
170 =item publicinbox.<name>.replyto
172 May be used to control how reply instructions in the PSGI
173 interface are displayed.
175 ":none=dead inbox" may be specified to denote an inactive list
176 ("dead inbox" may be replaced with another phrase).
178 A list of comma-delimited email addresses may be specified.
179 This can be useful for dedicated inboxes for bot emails, but
180 discussion happens on a separate mailing list/inbox.
182 Mirrors of existing centralized mailing lists may use ":list"
183 here to redirect mail only to the configured inbox address.
184 The use of ":list" is discouraged for new mailing lists, as it
185 leads to centralization.
189 =item publicinbox.css
191 The local path name of a CSS file for the PSGI web interface.
192 May contain the attributes "media", "title" and "href" which match
193 the associated attributes of the HTML <style> tag.
194 "href" may be specified to point to the URL of an remote CSS file
195 and the path may be "/dev/null" or any empty file.
196 Multiple files may be specified and will be included in the
199 =item publicinboxmda.spamcheck
201 This may be set to C<none> to disable the use of SpamAssassin
202 L<spamc(1)> for filtering spam before it is imported into git
203 history. Other spam filtering backends may be supported in
208 =item publicinboxwatch.spamcheck
210 See L<public-inbox-watch(1)>
212 =item publicinboxwatch.watchspam
214 See L<public-inbox-watch(1)>
216 =item publicinbox.imapserver
218 Set this to point to the hostname(s) of the L<public-inbox-imapd(1)>
219 instance. This is used to advertise the existence of the IMAP
220 endpoint in the L<PublicInbox::WWW> HTML interface.
224 =item publicinbox.nntpserver
226 Same as C<publicinbox.imapserver>, but for the hostname(s) of the
227 L<public-inbox-nntpd(1)> instance.
231 =item publicinbox.pop3server
233 Same as C<publicinbox.imapserver>, but for the hostname(s) of the
234 L<public-inbox-pop3d(1)> instance.
238 =item publicinbox.pop3state
240 See L<public-inbox-pop3d(1)/publicinbox.pop3state>
242 =item publicinbox.<name>.feedmax
244 The size of an Atom feed for the inbox. If specified more than
245 once, only the last value is used. Invalid values (<= 0) will
246 be treated as the default value.
250 =item publicinbox.<name>.hide
252 A comma-delimited list of listings to hide the inbox from.
254 Valid values are currently C<www> and C<manifest>.
258 =item coderepo.<nick>.dir
260 The path to a git repository for "publicinbox.<name>.coderepo"
262 =item coderepo.<nick>.cgitUrl
264 The URL of the cgit instance associated with the coderepo.
268 =item coderepo.snapshots
270 See C<snapshots> in L<cgitrc(5)>
272 =item publicinbox.cgitrc
274 A path to a L<cgitrc(5)> file. "repo.url" directives in the cgitrc
275 will be mapped to the nickname of a coderepo (without trailing slash),
276 and "repo.path" directives map to "coderepo.<nick>.dir".
277 Use of this directive allows admins of existing cgit installations
278 to skip declaring coderepo sections and map inboxes directly to
279 code repositories known to cgit.
281 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
283 =item publicinbox.cgitbin
285 A path to the C<cgit.cgi> executable. The L<PublicInbox::WWW>
286 interface can spawn cgit as a fallback if the publicinbox.cgitrc
287 directive is configured.
289 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
291 =item publicinbox.cgitdata
293 A path to the data directory used by cgit for storing static files.
294 Typically guessed based the location of C<cgit.cgi> (from
295 C<publicinbox.cgitbin>, but may be overridden.
297 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
300 =item publicinbox.cgit
302 Controls whether or not and how C<cgit> is used for serving coderepos.
303 New in public-inbox 2.0.0 (PENDING).
309 Try using C<cgit> as the first choice, this is the default.
313 Fall back to using C<cgit> only if our native, inbox-aware
314 git code repository viewer doesn't recognized the URL.
318 Rewrite C<cgit> URLs for our native, inbox-aware code repository viewer.
319 This implies C<fallback> for URLs the native viewer does not recognize.
323 Default: C<first> (C<cgit> will be used iff C<publicinbox.cgitrc>
324 is set and the C<cgit> binary exists).
326 =item publicinbox.mailEditor
328 See L<public-inbox-edit(1)>
330 =item publicinbox.indexMaxSize
331 =item publicinbox.indexBatchSize
332 =item publicinbox.indexSequentialShard
334 See L<public-inbox-index(1)>
336 =item publicinbox.wwwlisting
338 Enable a HTML listing style when the root path of the URL '/' is accessed.
347 - Return a 404 page. This is useful to allow customization with
348 L<Plack::App::Cascade(3pm)>
351 - Only show inboxes with URLs which belong to the domain of the HTTP request
354 TODO support showing cgit listing
360 =item publicinbox.grokmanifest
362 Controls the generation of a grokmirror-compatible gzipped JSON file
363 at the top-level of the PSGI interface. You generally do not need to
364 change this from the default.
371 - Only include inboxes with URLs which belong to the domain of
372 the HTTP request. This is compatible with virtual hosting where
373 several domains come from the same host.
376 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
377 Only use this if you're serving HTTP requests in a domain-agnostic manner.
380 - C<manifest.js.gz> will only contain an empty JSON array.
381 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
382 always contain all git repos used by the inbox at C<$INBOX_URL>
386 Default: C<match=domain>
388 =item publicinbox.<name>.obfuscate
390 Whether to obfuscate email addresses in the L<PublicInbox::WWW> HTML
395 =item publicinbox.noObfuscate
397 A space-delimited list of well-known addresses and domains that should
398 not be obfuscated when C<publicinbox.$NAME.obfuscate> is true (e.g.,
399 C<public@example.com> and C<@example.com>). This may be specified
400 more than once, in which case the values are merged.
404 =item extindex.<name>.topdir
406 The directory of an external index. See
407 L<public-inbox-extindex(1)> for more details.
409 =item extindex.<name>.url
411 Identical to L</publicinbox.E<lt>nameE<gt>.url>, but for
414 =item extindex.<name>.coderepo
416 Identical to L</publicinbox.E<lt>nameE<gt>.coderepo>, but for
417 external indices. Code repos may be freely associated with
418 any number of public inboxes and external indices.
422 =head2 NAMED LIMITER (PSGI)
424 Named limiters are useful for preventing large inboxes from
425 monopolizing (or overloading) the server. Since serving git
426 clones (via L<git-http-backend(1)> can be memory-intensive for
427 large inboxes, it makes sense to put large inboxes on a named
428 limiter with a low max value; while smaller inboxes can use
431 C<RLIMIT_*> keys may be set to enforce resource limits for
432 a particular limiter (L<BSD::Resource(3pm)> is required).
434 Default named-limiters are prefixed with "-". Currently,
435 the "-cgit" named limiter is reserved for instances spawning
436 cgit via C<publicinbox.cgitrc>
440 =item publicinboxlimiter.<name>.max
442 The maximum number of parallel processes for the given limiter.
444 =item publicinboxlimiter.<name>.rlimitCore
446 =item publicinboxlimiter.<name>.rlimitCPU
448 =item publicinboxlimiter.<name>.rlimitData
450 The maximum core size, CPU time, or data size processes run with the
451 given limiter will use. This may be comma-separated to distinguish
452 soft and hard limits. The word "INFINITY" is accepted as the
453 RLIM_INFINITY constant (if supported by your OS).
455 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
456 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
460 =head3 EXAMPLE WITH NAMED LIMITERS
462 ; big inboxes which require lots of memory to clone:
464 inboxdir = /path/to/big1
465 address = big1@example.com
468 inboxdir = /path/to/big2
469 address = big2@example.com
472 ; tiny inboxes which are easily cloned:
473 [publicinbox "tiny1"]
474 inboxdir = /path/to/tiny1
475 address = tiny1@example.com
476 [publicinbox "tiny2"]
477 inboxdir = /path/to/tiny2
478 address = tiny2@example.com
480 [publicinboxlimiter "big"]
483 In the above example, the "big1" and "big2" are limited to four
484 parallel L<git-http-backend(1)> processes between them.
486 However, "tiny1" and "tiny2" will share the default limiter
487 which means there can be 32 L<git-http-backend(1)> processes
496 Used to override the default "~/.public-inbox/config" value.
502 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
504 The mail archives are hosted at L<https://public-inbox.org/meta/> and
505 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
509 Copyright all contributors L<mailto:meta@public-inbox.org>
511 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
515 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
516 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
517 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>