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 matching
91 the given header. Multiple values are not currently supported.
93 Default: none; only for L<public-inbox-watch(1)> users
95 =item publicinbox.<name>.listid
97 The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
98 angle brackets for L<public-inbox-mda(1)> deliveries and
99 L<public-inbox-watch(1)>.
101 For public-inbox-watch users, this is a shortcut for specifying
102 C<publicinbox.$NAME.watchheader=List-Id:<foo.example.com>>
104 For public-inbox-mda users, this may be used to avoid recipient
105 matching via C<ORIGINAL_RECIPIENT> environment variable.
107 This may be specified multiple times for merging multiple mailing
108 lists into a single public-inbox, only one C<List-Id> header
113 =item publicinbox.<name>.nntpmirror
115 This may be the full NNTP URL of an independently-run mirror.
116 For example, the https://public-inbox.org/meta/ inbox is
118 C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
122 =item publicinbox.<name>.indexlevel
124 The indexing level for L<public-inbox-index(1)>
126 C<basic> only requires L<DBD::SQLite(3pm)> and provides all
127 NNTP functionality along with thread-awareness in the WWW
130 C<medium> requires L<Search::Xapian(3pm)> to provide full-text
131 term search functionality in the WWW UI.
133 C<full> also includes positional information used by Xapian to
134 allow for searching for phrases using quoted text.
135 (e.g. C<"looking for a complete sentence">)
139 =item publicinbox.<name>.httpbackendmax
141 If a digit, the maximum number of parallel
142 L<git-http-backend(1)> processes to allow for cloning this
145 If an alphanumeric value starting with a lowercase alphabetic
146 character is specified, the inbox will use a L</NAMED LIMITER>
147 which can be shared by multiple inboxes.
149 Default: 32 (using a default limiter shared by all inboxes)
151 =item publicinbox.<name>.coderepo
153 The nickname of a "coderepo" section associated with the inbox.
154 May be specified more than once for M:N mapping of code repos to
155 inboxes. If enabled, diff hunk headers in patch emails will
156 link to the line numbers of blobs.
160 =item publicinbox.<name>.replyto
162 May be used to control how reply instructions in the PSGI
163 interface are displayed.
165 ":none=dead inbox" may be specified to denote an inactive list
166 ("dead inbox" may be replaced with another phrase).
168 A list of comma-delimited email addresses may be specified.
169 This can be useful for dedicated inboxes for bot emails, but
170 discussion happens on a separate mailing list/inbox.
172 Mirrors of existing centralized mailing lists may use ":list"
173 here to redirect mail only to the configured inbox address.
174 The use of ":list" is discouraged for new mailing lists, as it
175 leads to centralization.
179 =item publicinbox.css
181 The local path name of a CSS file for the PSGI web interface.
182 May contain the attributes "media", "title" and "href" which match
183 the associated attributes of the HTML <style> tag.
184 "href" may be specified to point to the URL of an remote CSS file
185 and the path may be "/dev/null" or any empty file.
186 Multiple files may be specified and will be included in the
189 =item publicinboxmda.spamcheck
191 This may be set to C<none> to disable the use of SpamAssassin
192 L<spamc(1)> for filtering spam before it is imported into git
193 history. Other spam filtering backends may be supported in
198 =item publicinboxwatch.spamcheck
200 This may be set to C<spamc> to enable the use of SpamAssassin
201 L<spamc(1)> for filtering spam before it is imported into git
202 history. Other spam filtering backends may be supported in
205 This requires L<public-inbox-watch(1)>, but affects all configured
206 public-inboxes in PI_CONFIG.
210 =item publicinboxwatch.watchspam
212 A Maildir to watch for confirmed spam messages to appear in.
213 Messages which appear in this folder with the (S)een Maildir flag
214 will be hidden from all configured inboxes based on Message-ID
215 and content matching.
217 Messages without the (S)een Maildir flag are not considered for hiding.
219 Default: none; only for L<public-inbox-watch(1)> users
221 =item publicinbox.nntpserver
223 Set this to point to the address of the L<public-inbox-nntpd(1)>
224 instance. This is used to advertise the existence of the NNTP
225 presnce in the L<PublicInbox::WWW> HTML interface.
227 Multiple values are allowed for servers with multiple
228 addresses or mirrors.
232 =item publicinbox.<name>.feedmax
234 The size of an Atom feed for the inbox. If specified more than
235 once, only the last value is used. Invalid values (<= 0) will
236 be treated as the default value.
240 =item publicinbox.<name>.hide
242 A comma-delimited list of listings to hide the inbox from.
244 Valid values are currently C<www> and C<manifest>.
248 =item coderepo.<nick>.dir
250 The path to a git repository for "publicinbox.<name>.coderepo"
252 =item coderepo.<nick>.cgitUrl
254 The URL of the cgit instance associated with the coderepo.
258 =item publicinbox.cgitrc
260 A path to a L<cgitrc(5)> file. "repo.url" directives in the cgitrc
261 will be mapped to the nickname of a coderepo (without trailing slash),
262 and "repo.path" directives map to "coderepo.<nick>.dir".
263 Use of this directive allows admins of existing cgit installations
264 to skip declaring coderepo sections and map inboxes directly to
265 code repositories known to cgit.
267 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
269 =item publicinbox.cgitbin
271 A path to the C<cgit.cgi> executable. The L<PublicInbox::WWW>
272 interface can spawn cgit as a fallback if the publicinbox.cgitrc
273 directive is configured.
275 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
277 =item publicinbox.cgitdata
279 A path to the data directory used by cgit for storing static files.
280 Typically guessed based the location of C<cgit.cgi> (from
281 C<publicinbox.cgitbin>, but may be overridden.
283 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
286 =item publicinbox.mailEditor
288 See L<public-inbox-edit(1)>
290 =item publicinbox.wwwlisting
292 Enable a HTML listing style when the root path of the URL '/' is accessed.
301 - Return a 404 page. This is useful to allow customization with
302 L<Plack::App::Cascade(3pm)>
305 - Only show inboxes with URLs which belong to the domain of the HTTP request
309 support showing cgit listing
315 =item publicinbox.grokmanifest
317 Controls the generation of a grokmirror-compatible gzipped JSON file
318 at the top-level of the PSGI interface. You generally do not need to
319 change this from the default.
326 - Only include inboxes with URLs which belong to the domain of
327 the HTTP request. This is compatible with virtual hosting where
328 several domains come from the same host.
331 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
332 Only use this if you're serving HTTP requests in a domain-agnostic manner.
335 - C<manifest.js.gz> will only contain an empty JSON array.
336 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
337 always contain all git repos used by the inbox at C<$INBOX_URL>
341 Default: C<match=domain>
345 =head2 NAMED LIMITER (PSGI)
347 Named limiters are useful for preventing large inboxes from
348 monopolizing (or overloading) the server. Since serving git
349 clones (via L<git-http-backend(1)> can be memory-intensive for
350 large inboxes, it makes sense to put large inboxes on a named
351 limiter with a low max value; while smaller inboxes can use
354 C<RLIMIT_*> keys may be set to enforce resource limits for
355 a particular limiter.
357 Default named-limiters are prefixed with "-". Currently,
358 the "-cgit" named limiter is reserved for instances spawning
359 cgit via C<publicinbox.cgitrc>
363 =item publicinboxlimiter.<name>.max
365 The maximum number of parallel processes for the given limiter.
367 =item publicinboxlimiter.<name>.rlimitCore
369 =item publicinboxlimiter.<name>.rlimitCPU
371 =item publicinboxlimiter.<name>.rlimitData
373 The maximum core size, CPU time, or data size processes run with the
374 given limiter will use. This may be comma-separated to distinguish
375 soft and hard limits. The word "INFINITY" is accepted as the
376 RLIM_INFINITY constant (if supported by your OS).
378 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
379 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
383 =head3 EXAMPLE WITH NAMED LIMITERS
385 ; big inboxes which require lots of memory to clone:
387 inboxdir = /path/to/big1
388 address = big1@example.com
391 inboxdir = /path/to/big2
392 address = big2@example.com
395 ; tiny inboxes which are easily cloned:
396 [publicinbox "tiny1"]
397 inboxdir = /path/to/tiny1
398 address = tiny1@example.com
399 [publicinbox "tiny2"]
400 inboxdir = /path/to/tiny2
401 address = tiny2@example.com
403 [publicinboxlimiter "big"]
406 In the above example, the "big1" and "big2" are limited to four
407 parallel L<git-http-backend(1)> processes between them.
409 However, "tiny1" and "tiny2" will share the default limiter
410 which means there can be 32 L<git-http-backend(1)> processes
419 Used to override the default "~/.public-inbox/config" value.
425 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
427 The mail archives are hosted at L<https://public-inbox.org/meta/>
428 and L<http://hjrcffqmbrq6wope.onion/meta/>
432 Copyright 2016-2019 all contributors L<mailto:meta@public-inbox.org>
434 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
438 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
439 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
440 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>