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 directory 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 publicinbox.<name>.httpbackendmax
96 If a digit, the maximum number of parallel
97 L<git-http-backend(1)> processes to allow for cloning this
100 If an alphanumeric value starting with a lowercase alphabetic
101 character is specified, the inbox will use a L</NAMED LIMITER>
102 which can be shared by multiple inboxes.
104 Default: 32 (using a default limiter shared by all inboxes)
106 =item publicinbox.<name>.coderepo
108 The nickname of a "coderepo" section associated with the inbox.
109 May be specified more than once for M:N mapping of code repos to
110 inboxes. If enabled, diff hunk headers in patch emails will
111 link to the line numbers of blobs.
115 =item publicinbox.<name>.replyto
117 May be used to control how reply instructions in the PSGI
118 interface are displayed.
120 ":none=dead inbox" may be specified to denote an inactive list
121 ("dead inbox" may be replaced with another phrase).
123 A list of comma-delimited email addresses may be specified.
124 This can be useful for dedicated inboxes for bot emails, but
125 discussion happens on a seperate mailing list/inbox.
127 Mirrors of existing centralized mailing lists may use ":list"
128 here to redirect mail only to the configured inbox address.
129 The use of ":list" is discouraged for new mailing lists, as it
130 leads to centralization.
134 =item publicinbox.css
136 The local path name of a CSS file for the PSGI web interface.
137 May contain the attributes "media", "title" and "href" which match
138 the associated attributes of the HTML <style> tag.
139 "href" may be specified to point to the URL of an remote CSS file
140 and the path may be "/dev/null" or any empty file.
141 Multiple files may be specified and will be included in the
144 =item publicinboxmda.spamcheck
146 This may be set to C<none> to disable the use of SpamAssassin
147 L<spamc(1)> for filtering spam before it is imported into git
148 history. Other spam filtering backends may be supported in
153 =item publicinboxwatch.spamcheck
155 This may be set to C<spamc> to enable the use of SpamAssassin
156 L<spamc(1)> for filtering spam before it is imported into git
157 history. Other spam filtering backends may be supported in
162 =item publicinboxwatch.watchspam
164 This may be set to C<spamc> to enable the use of SpamAssassin
165 L<spamc(1)> for filtering spam before it is imported into git
166 history. Other spam filtering backends may be supported in
167 the future. This requires L<public-inbox-watch(1)>, but affects
168 all configured public-inboxes in PI_CONFIG.
172 =item publicinbox.nntpserver
174 Set this to point to the address of the L<public-inbox-nntpd(1)>
175 instance. This is used to advertise the existence of the NNTP
176 presnce in the L<PublicInbox::WWW> HTML interface.
178 Multiple values are allowed for servers with multiple
179 addresses or mirrors.
183 =item publicinbox.<name>.feedmax
185 The size of an Atom feed for the inbox. If specified more than
186 once, only the last value is used. Invalid values (<= 0) will
187 be treated as the default value.
191 =item publicinbox.<name>.hide
193 A comma-delimited list of listings to hide the inbox from.
195 Valid values are currently "www".
199 =item coderepo.<nick>.dir
201 The path to a git repository for "publicinbox.<name>.coderepo"
203 =item coderepo.<nick>.cgitUrl
205 The URL of the cgit instance associated with the coderepo.
209 =item publicinbox.cgitrc
211 A path to a L<cgitrc(5)> file. "repo.url" directives in the cgitrc
212 will be mapped to the nickname of a coderepo (without trailing slash),
213 and "repo.path" directives map to "coderepo.<nick>.dir".
214 Use of this directive allows admins of existing cgit installations
215 to skip declaring coderepo sections and map inboxes directly to
216 code repositories known to cgit.
218 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
220 =item publicinbox.cgitbin
222 A path to the C<cgit.cgi> executable. The L<PublicInbox::WWW>
223 interface can spawn cgit as a fallback if the publicinbox.cgitrc
224 directive is configured.
226 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
228 =item publicinbox.cgitdata
230 A path to the data directory used by cgit for storing static files.
231 Typically guessed based the location of C<cgit.cgi> (from
232 C<publicinbox.cgitbin>, but may be overridden.
234 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
237 =item publicinbox.mailEditor
239 See L<public-inbox-edit(1)>
241 =item publicinbox.wwwlisting
243 Enable a HTML listing style when the root path of the URL '/' is accessed.
252 - Return a 404 page. This is useful to allow customization with
253 L<Plack::App::Cascade(3pm)>
256 - Only show inboxes with URLs which belong to the domain of the HTTP request
260 support showing cgit listing
268 =head2 NAMED LIMITER (PSGI)
270 Named limiters are useful for preventing large inboxes from
271 monopolizing (or overloading) the server. Since serving git
272 clones (via L<git-http-backend(1)> can be memory-intensive for
273 large inboxes, it makes sense to put large inboxes on a named
274 limiter with a low max value; while smaller inboxes can use
277 C<RLIMIT_*> keys may be set to enforce resource limits for
278 a particular limiter.
280 Default named-limiters are prefixed with "-". Currently,
281 the "-cgit" named limiter is reserved for instances spawning
282 cgit via C<publicinbox.cgitrc>
286 =item publicinboxlimiter.<name>.max
288 The maximum number of parallel processes for the given limiter.
290 =item publicinboxlimiter.<name>.rlimitCore
292 =item publicinboxlimiter.<name>.rlimitCPU
294 =item publicinboxlimiter.<name>.rlimitData
296 The maximum core size, CPU time, or data size processes run with the
297 given limiter will use. This may be comma-separated to distinguish
298 soft and hard limits. The word "INFINITY" is accepted as the
299 RLIM_INFINITY constant (if supported by your OS).
301 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
302 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
306 =head3 EXAMPLE WITH NAMED LIMITERS
308 ; big inboxes which require lots of memory to clone:
310 mainrepo = /path/to/big1
311 address = big1@example.com
314 mainrepo = /path/to/big2
315 address = big2@example.com
318 ; tiny inboxes which are easily cloned:
319 [publicinbox "tiny1"]
320 mainrepo = /path/to/tiny1
321 address = tiny1@example.com
322 [publicinbox "tiny2"]
323 mainrepo = /path/to/tiny2
324 address = tiny2@example.com
326 [publicinboxlimiter "big"]
329 In the above example, the "big1" and "big2" are limited to four
330 parallel L<git-http-backend(1)> processes between them.
332 However, "tiny1" and "tiny2" will share the default limiter
333 which means there can be 32 L<git-http-backend(1)> processes
342 Used to override the default "~/.public-inbox/config" value.
348 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
350 The mail archives are hosted at L<https://public-inbox.org/meta/>
351 and L<http://hjrcffqmbrq6wope.onion/meta/>
355 Copyright 2016-2018 all contributors L<mailto:meta@public-inbox.org>
357 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
361 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
362 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>