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)>.
72 Omitting this for a given inbox will prevent the inbox from
73 being served by L<public-inbox-nntpd(1)> and/or L<public-inbox-imapd(1)>.
75 Default: none, optional
77 =item publicinbox.<name>.watch
79 See L<public-inbox-watch(1)>
81 =item publicinbox.<name>.watchheader
83 See L<public-inbox-watch(1)>
85 =item publicinbox.<name>.listid
87 The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
88 angle brackets for L<public-inbox-mda(1)> deliveries and
89 L<public-inbox-watch(1)>.
91 For public-inbox-watch users, this is a shortcut for specifying
92 C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
94 For public-inbox-mda users, this may be used to avoid recipient
95 matching via C<ORIGINAL_RECIPIENT> environment variable.
97 This may be specified multiple times for merging multiple mailing
98 lists into a single public-inbox, only one C<List-Id> header
103 =item publicinbox.<name>.imapmirror
105 This may be the full IMAP URL of an independently-run IMAP mirror.
109 =item publicinbox.<name>.nntpmirror
111 This may be the full NNTP URL of an independently-run mirror.
112 For example, the https://public-inbox.org/meta/ inbox is
114 C<nntp://news.gmane.io/gmane.mail.public-inbox.general>
118 =item publicinbox.<name>.indexlevel
120 The indexing level for L<public-inbox-index(1)>
122 C<basic> only requires L<DBD::SQLite(3pm)> and provides all
123 NNTP functionality along with thread-awareness in the WWW
126 C<medium> requires L<Search::Xapian(3pm)> to provide full-text
127 term search functionality in the WWW UI.
129 C<full> also includes positional information used by Xapian to
130 allow for searching for phrases using quoted text.
131 (e.g. C<"looking for a complete sentence">)
135 =item publicinbox.<name>.boost
137 Control indexing order for L<public-inbox-extindex(1)>, with ties
138 broken by config file order. This only affects indexing and does
139 not affect messages which are already indexed.
143 =item publicinbox.<name>.indexSequentialShard
145 See L<public-inbox-index(1)/publicInbox.indexSequentialShard>
147 =item publicinbox.<name>.httpbackendmax
149 If a digit, the maximum number of parallel
150 L<git-http-backend(1)> processes to allow for cloning this
153 If an alphanumeric value starting with a lowercase alphabetic
154 character is specified, the inbox will use a L</NAMED LIMITER>
155 which can be shared by multiple inboxes.
157 Default: 32 (using a default limiter shared by all inboxes)
159 =item publicinbox.<name>.coderepo
161 The nickname of a "coderepo" section associated with the inbox.
162 May be specified more than once for M:N mapping of code repos to
163 inboxes. If enabled, diff hunk headers in patch emails will
164 link to the line numbers of blobs.
168 =item publicinbox.<name>.replyto
170 May be used to control how reply instructions in the PSGI
171 interface are displayed.
173 ":none=dead inbox" may be specified to denote an inactive list
174 ("dead inbox" may be replaced with another phrase).
176 A list of comma-delimited email addresses may be specified.
177 This can be useful for dedicated inboxes for bot emails, but
178 discussion happens on a separate mailing list/inbox.
180 Mirrors of existing centralized mailing lists may use ":list"
181 here to redirect mail only to the configured inbox address.
182 The use of ":list" is discouraged for new mailing lists, as it
183 leads to centralization.
187 =item publicinbox.css
189 The local path name of a CSS file for the PSGI web interface.
190 May contain the attributes "media", "title" and "href" which match
191 the associated attributes of the HTML <style> tag.
192 "href" may be specified to point to the URL of an remote CSS file
193 and the path may be "/dev/null" or any empty file.
194 Multiple files may be specified and will be included in the
197 =item publicinboxmda.spamcheck
199 This may be set to C<none> to disable the use of SpamAssassin
200 L<spamc(1)> for filtering spam before it is imported into git
201 history. Other spam filtering backends may be supported in
206 =item publicinboxwatch.spamcheck
208 See L<public-inbox-watch(1)>
210 =item publicinboxwatch.watchspam
212 See L<public-inbox-watch(1)>
214 =item publicinbox.imapserver
216 Set this to point to the hostname(s) of the L<public-inbox-imapd(1)>
217 instance. This is used to advertise the existence of the IMAP
218 endpoint in the L<PublicInbox::WWW> HTML interface.
222 =item publicinbox.nntpserver
224 Same as C<publicinbox.imapserver>, but for the hostname(s) of the
225 L<public-inbox-nntpd(1)> instance.
229 =item publicinbox.<name>.feedmax
231 The size of an Atom feed for the inbox. If specified more than
232 once, only the last value is used. Invalid values (<= 0) will
233 be treated as the default value.
237 =item publicinbox.<name>.hide
239 A comma-delimited list of listings to hide the inbox from.
241 Valid values are currently C<www> and C<manifest>.
245 =item coderepo.<nick>.dir
247 The path to a git repository for "publicinbox.<name>.coderepo"
249 =item coderepo.<nick>.cgitUrl
251 The URL of the cgit instance associated with the coderepo.
255 =item publicinbox.cgitrc
257 A path to a L<cgitrc(5)> file. "repo.url" directives in the cgitrc
258 will be mapped to the nickname of a coderepo (without trailing slash),
259 and "repo.path" directives map to "coderepo.<nick>.dir".
260 Use of this directive allows admins of existing cgit installations
261 to skip declaring coderepo sections and map inboxes directly to
262 code repositories known to cgit.
264 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
266 =item publicinbox.cgitbin
268 A path to the C<cgit.cgi> executable. The L<PublicInbox::WWW>
269 interface can spawn cgit as a fallback if the publicinbox.cgitrc
270 directive is configured.
272 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
274 =item publicinbox.cgitdata
276 A path to the data directory used by cgit for storing static files.
277 Typically guessed based the location of C<cgit.cgi> (from
278 C<publicinbox.cgitbin>, but may be overridden.
280 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
283 =item publicinbox.mailEditor
285 See L<public-inbox-edit(1)>
287 =item publicinbox.indexMaxSize
288 =item publicinbox.indexBatchSize
289 =item publicinbox.indexSequentialShard
291 See L<public-inbox-index(1)>
293 =item publicinbox.wwwlisting
295 Enable a HTML listing style when the root path of the URL '/' is accessed.
304 - Return a 404 page. This is useful to allow customization with
305 L<Plack::App::Cascade(3pm)>
308 - Only show inboxes with URLs which belong to the domain of the HTTP request
311 TODO support showing cgit listing
317 =item publicinbox.grokmanifest
319 Controls the generation of a grokmirror-compatible gzipped JSON file
320 at the top-level of the PSGI interface. You generally do not need to
321 change this from the default.
328 - Only include inboxes with URLs which belong to the domain of
329 the HTTP request. This is compatible with virtual hosting where
330 several domains come from the same host.
333 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
334 Only use this if you're serving HTTP requests in a domain-agnostic manner.
337 - C<manifest.js.gz> will only contain an empty JSON array.
338 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
339 always contain all git repos used by the inbox at C<$INBOX_URL>
343 Default: C<match=domain>
345 =item publicinbox.<name>.obfuscate
347 Whether to obfuscate email addresses in the L<PublicInbox::WWW> HTML
352 =item publicinbox.noObfuscate
354 A space-delimited list of well-known addresses and domains that should
355 not be obfuscated when C<publicinbox.$NAME.obfuscate> is true (e.g.,
356 C<public@example.com> and C<@example.com>). This may be specified
357 more than once, in which case the values are merged.
363 =head2 NAMED LIMITER (PSGI)
365 Named limiters are useful for preventing large inboxes from
366 monopolizing (or overloading) the server. Since serving git
367 clones (via L<git-http-backend(1)> can be memory-intensive for
368 large inboxes, it makes sense to put large inboxes on a named
369 limiter with a low max value; while smaller inboxes can use
372 C<RLIMIT_*> keys may be set to enforce resource limits for
373 a particular limiter (L<BSD::Resource(3pm)> is required).
375 Default named-limiters are prefixed with "-". Currently,
376 the "-cgit" named limiter is reserved for instances spawning
377 cgit via C<publicinbox.cgitrc>
381 =item publicinboxlimiter.<name>.max
383 The maximum number of parallel processes for the given limiter.
385 =item publicinboxlimiter.<name>.rlimitCore
387 =item publicinboxlimiter.<name>.rlimitCPU
389 =item publicinboxlimiter.<name>.rlimitData
391 The maximum core size, CPU time, or data size processes run with the
392 given limiter will use. This may be comma-separated to distinguish
393 soft and hard limits. The word "INFINITY" is accepted as the
394 RLIM_INFINITY constant (if supported by your OS).
396 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
397 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
401 =head3 EXAMPLE WITH NAMED LIMITERS
403 ; big inboxes which require lots of memory to clone:
405 inboxdir = /path/to/big1
406 address = big1@example.com
409 inboxdir = /path/to/big2
410 address = big2@example.com
413 ; tiny inboxes which are easily cloned:
414 [publicinbox "tiny1"]
415 inboxdir = /path/to/tiny1
416 address = tiny1@example.com
417 [publicinbox "tiny2"]
418 inboxdir = /path/to/tiny2
419 address = tiny2@example.com
421 [publicinboxlimiter "big"]
424 In the above example, the "big1" and "big2" are limited to four
425 parallel L<git-http-backend(1)> processes between them.
427 However, "tiny1" and "tiny2" will share the default limiter
428 which means there can be 32 L<git-http-backend(1)> processes
437 Used to override the default "~/.public-inbox/config" value.
443 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
445 The mail archives are hosted at L<https://public-inbox.org/meta/> and
446 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
450 Copyright 2016-2021 all contributors L<mailto:meta@public-inbox.org>
452 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
456 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
457 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
458 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>