public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob b4a1d94dec00892d1abe717e63cadce14fec1e9a 15585 bytes (raw)
$ git show HEAD:Documentation/public-inbox-config.pod	# shows this blob on the CLI

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
=head1 NAME

public-inbox-config - public-inbox config file description

=head1 SYNOPSIS

~/.public-inbox/config

=head1 DESCRIPTION

The public-inbox config file is parseable by L<git-config(1)>.
This is a global configuration file for mapping/discovering
all public-inboxes used by a particular user.

=head1 CONFIGURATION FILE

=head2 EXAMPLE

	[publicinbox "test"]
		inboxdir = /home/user/path/to/test.git
		; multiple addresses are supported
		address = test@example.com
		; address = alternate@example.com
		url = http://example.com/test
		newsgroup = inbox.test

		; backwards compatibility with public-inbox pre-1.2.0,
		; "inboxdir" takes precedence over "mainrepo"
		mainrepo = /home/user/path/to/test.git

=head2 VARIABLES

=over 8

=item publicinbox.<name>.address

The email address of the public-inbox.  May be specified
more than once for merging multiple mailing lists (or migrating
to new addresses).  This must be specified at least once,
the first value will be considered the primary address for
informational purposes.

Default: none, required

=item publicinbox.<name>.inboxdir

The absolute path to the directory which hosts the
public-inbox.  This must be specified once.

This was previously known as "mainrepo", which remains supported,
but "inboxdir" takes precedence.

Default: none, required

=item publicinbox.<name>.url

The primary URL for hosting the HTTP/HTTPS archives.
Additional HTTP/HTTPS URLs may be specified via
C<$GIT_DIR/cloneurl> as documented in L<gitweb(1)>

Default: none, optional

=item publicinbox.<name>.newsgroup

The NNTP group name for use with L<public-inbox-nntpd(1)>.  This
may be any newsgroup name with hierarchies delimited by C<.>.
For example, the newsgroup for L<mailto:meta@public-inbox.org>
is: C<inbox.comp.mail.public-inbox.meta>

It also configures the folder hierarchy used by L<public-inbox-imapd(1)>
as well as L<public-inbox-pop3d(1)>

Omitting this for a given inbox will prevent the inbox from
being served by L<public-inbox-nntpd(1)>,
L<public-inbox-imapd(1)>, and/or L<public-inbox-pop3d(1)>

Newsgroup names should be all lowercase.  Uppercase characters are
converted to lowercase for compatibility with IMAP, POP3, and our
L<public-inbox-extindex(1)> and L<public-inbox-cindex(1)> tools
starting with public-inbox 2.0+ (they were unusable before).

Default: none, optional

=item publicinbox.<name>.watch

See L<public-inbox-watch(1)>

=item publicinbox.<name>.watchheader

See L<public-inbox-watch(1)>

=item publicinbox.<name>.listid

The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
angle brackets for L<public-inbox-mda(1)> deliveries and
L<public-inbox-watch(1)>.

For public-inbox-watch users, this is a shortcut for specifying
C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>

For public-inbox-mda users, this may be used to avoid recipient
matching via C<ORIGINAL_RECIPIENT> environment variable.

This may be specified multiple times for merging multiple mailing
lists into a single public-inbox, only one C<List-Id> header
needs to match.

Default: none

=item publicinbox.<name>.imapmirror

This may be the full IMAP URL of an independently-run IMAP mirror.

Default: none

=item publicinbox.<name>.nntpmirror

This may be the full NNTP URL of an independently-run mirror.
For example, the https://public-inbox.org/meta/ inbox is
mirrored by Gmane at
C<nntp://news.gmane.io/gmane.mail.public-inbox.general>

Default: none

=item publicinbox.<name>.indexlevel

The indexing level for L<public-inbox-index(1)>

C<basic> only requires L<DBD::SQLite(3pm)> and provides all
NNTP functionality along with thread-awareness in the WWW
interface.

C<medium> requires L<Xapian(3pm)> or L<Search::Xapian(3pm)> to provide
full-text term search functionality in the WWW UI.

C<full> also includes positional information used by Xapian to
allow for searching for phrases using quoted text.
(e.g. C<"looking for a complete sentence">)

Default: C<full>

=item publicinbox.<name>.boost

Control indexing order for L<public-inbox-extindex(1)>, with ties
broken by config file order.  This only affects indexing and does
not affect messages which are already indexed.

Default: C<0>

=item publicinbox.<name>.indexSequentialShard

See L<public-inbox-index(1)/publicInbox.indexSequentialShard>

=item publicinbox.<name>.httpbackendmax

If a digit, the maximum number of parallel
L<git-http-backend(1)> processes to allow for cloning this
particular inbox.

If an alphanumeric value starting with a lowercase alphabetic
character is specified, the inbox will use a L</NAMED LIMITER>
which can be shared by multiple inboxes.

Default: 32 (using a default limiter shared by all inboxes)

=item publicinbox.<name>.coderepo

The nickname of a "coderepo" section associated with the inbox.
May be specified more than once for M:N mapping of code repos to
inboxes.  If enabled, diff hunk headers in patch emails will
link to the line numbers of blobs.

Default: none

=item publicinbox.<name>.replyto

May be used to control how reply instructions in the PSGI
interface are displayed.

":none=dead inbox" may be specified to denote an inactive list
("dead inbox" may be replaced with another phrase).

A list of comma-delimited email addresses may be specified.
This can be useful for dedicated inboxes for bot emails, but
discussion happens on a separate mailing list/inbox.

Mirrors of existing centralized mailing lists may use ":list"
here to redirect mail only to the configured inbox address.
The use of ":list" is discouraged for new mailing lists, as it
leads to centralization.

Default: :all

=item publicinbox.css

The local path name of a CSS file for the PSGI web interface.
May contain the attributes "media", "title" and "href" which match
the associated attributes of the HTML <style> tag.
"href" may be specified to point to the URL of a remote CSS file
and the path may be "/dev/null" or any empty file.
Multiple files may be specified and will be included in the
order specified.

=item publicinboxImport.dropUniqueUnsubscribe

Drop C<List-Unsubscribe> headers if the message also includes
the C<List-Unsubscribe-Post: List-Unsubscribe=One-Click> header
to signal MUAs to support an instantaneous unsubscribe.  This
is strongly recommended for users creating their own public
archives of mailing lists they subscribe to, otherwise any
archive reader can unsubscribe the archivist.

This may break DKIM signatures if the C<List-Unsubscribe*>
headers are signed, but breaking DKIM signatures is the
lesser evil compared to allowing any reader to unsubscribe
the archivist.

This affects L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
and L<public-inbox-learn(1)>

=item publicinboxmda.spamcheck

This may be set to C<none> to disable the use of SpamAssassin
L<spamc(1)> for filtering spam before it is imported into git
history.  Other spam filtering backends may be supported in
the future.

Default: spamc

=item publicinboxwatch.spamcheck

See L<public-inbox-watch(1)>

=item publicinboxwatch.watchspam

See L<public-inbox-watch(1)>

=item publicinbox.imapserver

Set this to point to the hostname(s) of the L<public-inbox-imapd(1)>
instance.  This is used to advertise the existence of the IMAP
endpoint in the L<PublicInbox::WWW> HTML interface.

Default: none

=item publicinbox.nntpserver

Same as C<publicinbox.imapserver>, but for the hostname(s) of the
L<public-inbox-nntpd(1)> instance.

Default: none

=item publicinbox.pop3server

Same as C<publicinbox.imapserver>, but for the hostname(s) of the
L<public-inbox-pop3d(1)> instance.

Default: none

=item publicinbox.pop3state

See L<public-inbox-pop3d(1)/publicinbox.pop3state>

=item publicinbox.<name>.feedmax

The size of an Atom feed for the inbox.  If specified more than
once, only the last value is used.  Invalid values (<= 0) will
be treated as the default value.

Default: 25

=item publicinbox.<name>.hide

A comma-delimited list of listings to hide the inbox from.

Valid values are currently C<www> and C<manifest> for non-C<404>
values of L</publicinbox.wwwListing> and L</publicinbox.grokManifest>,
respectively

Default: none

=item coderepo.<nick>.dir

The path to a git repository for "publicinbox.<name>.coderepo"

=item coderepo.<nick>.cgitUrl

The URL of the cgit instance associated with the coderepo.

Default: none

=item coderepo.snapshots

See C<snapshots> in L<cgitrc(5)>

=item publicinbox.cgitrc

A path to a L<cgitrc(5)> file.  "repo.url" directives in the cgitrc
will be mapped to the nickname of a coderepo (without trailing slash),
and "repo.path" directives map to "coderepo.<nick>.dir".
Use of this directive allows admins of existing cgit installations
to skip declaring coderepo sections and map inboxes directly to
code repositories known to cgit.

Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.

=item publicinbox.cgitbin

A path to the C<cgit.cgi> executable.  The L<PublicInbox::WWW>
interface can spawn cgit as a fallback if the publicinbox.cgitrc
directive is configured.

Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi

=item publicinbox.cgitdata

A path to the data directory used by cgit for storing static files.
Typically guessed based on the location of C<cgit.cgi> (from
C<publicinbox.cgitbin>), but may be overridden.

Default: dirname of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
or /usr/share/cgit/

=item publicinbox.cgit

Controls whether or not and how C<cgit> is used for serving coderepos.
New in public-inbox 2.0.0 (PENDING).

=over 8

=item * first

Try using C<cgit> as the first choice, this is the default.

=item * fallback

Fall back to using C<cgit> only if our native, inbox-aware
git code repository viewer doesn't recognize the URL.

=begin comment
=for comment rewrite is not yet implemented
=item * rewrite

Rewrite C<cgit> URLs for our native, inbox-aware code repository viewer.
This implies C<fallback> for URLs the native viewer does not recognize.

=end comment

=back

Default: C<first>  (C<cgit> will be used iff C<publicinbox.cgitrc>
is set and the C<cgit> binary exists).

=item publicinbox.mailEditor

See L<public-inbox-edit(1)>

=item publicinbox.indexMaxSize

=item publicinbox.indexBatchSize

=item publicinbox.indexSequentialShard

See L<public-inbox-index(1)>

=item publicinbox.wwwlisting

Enable a HTML listing style when the root path of the URL '/' is accessed.
Valid values are:

=over 8

=item * all
- Show all inboxes

=item * 404
- Return a 404 page.  This is useful to allow customization with
L<Plack::App::Cascade(3pm)>

=item * match=domain
- Only show inboxes with URLs which belong to the domain of the HTTP request

=for comment
TODO support showing cgit listing

=back

Default: C<404>

=item publicinbox.nameIsUrl

Treat the name of the public inbox as its unqualified URL when
using C<publicInbox.wwwListing=all>.  That is, every
C<[publicinbox "foo"]> section implicitly sets C<publicinbox.foo.url=foo>.

This is a convenient alternative to specifying
C<publicinbox.E<lt>nameE<gt>.url> for every single inbox if
your inbox URLs are domain-agnostic when using
C<publicInbox.wwwListing=all>

Default: false

New in public-inbox 2.0.0 (PENDING).

=item publicinbox.grokmanifest

Controls the generation of a grokmirror-compatible gzipped JSON file
at the top-level of the PSGI interface.  You generally do not need to
change this from the default.

Valid values are:

=over 8

=item * match=domain
- Only include inboxes with URLs which belong to the domain of
the HTTP request.  This is compatible with virtual hosting where
several domains come from the same host.

=item * all
- All inboxes are present in C<manifest.js.gz>, regardless of domain.
Only use this if you're serving HTTP requests in a domain-agnostic manner.

=item * 404
- C<manifest.js.gz> will only contain an empty JSON array.
This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
always contain all git repos used by the inbox at C<$INBOX_URL>

=back

Default: C<match=domain>

=item publicinbox.<name>.obfuscate

Whether to obfuscate email addresses in the L<PublicInbox::WWW> HTML
interface.

Default: false

=item publicinbox.noObfuscate

A space-delimited list of well-known addresses and domains that should
not be obfuscated when C<publicinbox.$NAME.obfuscate> is true (e.g.,
C<public@example.com> and C<@example.com>).  This may be specified
more than once, in which case the values are merged.

Default: none

=item extindex.<name>.topdir

The directory of an external index.  See
L<public-inbox-extindex(1)> for more details.

=item extindex.<name>.url

Identical to L</publicinbox.E<lt>nameE<gt>.url>, but for
external indices

=item extindex.<name>.coderepo

Identical to L</publicinbox.E<lt>nameE<gt>.coderepo>, but for
external indices.  Code repos may be freely associated with
any number of public inboxes and external indices.

=back

=head2 NAMED LIMITER (PSGI)

Named limiters are useful for preventing large inboxes from
monopolizing (or overloading) the server.  Since serving git
clones (via L<git-http-backend(1)> can be memory-intensive for
large inboxes, it makes sense to put large inboxes on a named
limiter with a low max value; while smaller inboxes can use
the default limiter.

C<RLIMIT_*> keys may be set to enforce resource limits for
a particular limiter (L<BSD::Resource(3pm)> is required).

Default named-limiters are prefixed with "-".  Currently,
the "-cgit" named limiter is reserved for instances spawning
cgit via C<publicinbox.cgitrc>

=over 8

=item publicinboxlimiter.<name>.max

The maximum number of parallel processes for the given limiter.

=item publicinboxlimiter.<name>.rlimitCore

=item publicinboxlimiter.<name>.rlimitCPU

=item publicinboxlimiter.<name>.rlimitData

The maximum core size, CPU time, or data size processes run with the
given limiter will use.  This may be comma-separated to distinguish
soft and hard limits.  The word "INFINITY" is accepted as the
RLIM_INFINITY constant (if supported by your OS).

See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
RLIMIT_CPU, and RLIMIT_DATA for you operating system.

=back

=head3 EXAMPLE WITH NAMED LIMITERS

	; big inboxes which require lots of memory to clone:
	[publicinbox "big1"]
		inboxdir = /path/to/big1
		address = big1@example.com
		httpbackendmax = big
	[publicinbox "big2"]
		inboxdir = /path/to/big2
		address = big2@example.com
		httpbackendmax = big

	; tiny inboxes which are easily cloned:
	[publicinbox "tiny1"]
		inboxdir = /path/to/tiny1
		address = tiny1@example.com
	[publicinbox "tiny2"]
		inboxdir = /path/to/tiny2
		address = tiny2@example.com

	[publicinboxlimiter "big"]
		max = 4

In the above example, the "big1" and "big2" are limited to four
parallel L<git-http-backend(1)> processes between them.

However, "tiny1" and "tiny2" will share the default limiter
which means there can be 32 L<git-http-backend(1)> processes
between them.

=head1 ENVIRONMENT

=over 8

=item PI_CONFIG

Used to override the default "~/.public-inbox/config" value.

=back

=head1 CONTACT

Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>

The mail archives are hosted at L<https://public-inbox.org/meta/> and
L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

=head1 COPYRIGHT

Copyright all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>

=head1 SEE ALSO

L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>

git clone https://public-inbox.org/public-inbox.git
git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git