Documentation/public-inbox-config.pod

   1 =head1 NAME
   2
   3 public-inbox-config - public-inbox config file description
   4
   5 =head1 SYNOPSIS
   6
   7 ~/.public-inbox/config
   8
   9 =head1 DESCRIPTION
  10
  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.
  14
  15 =head1 CONFIGURATION FILE
  16
  17 =head2 EXAMPLE
  18
  19         [publicinbox "test"]
  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
  26
  27                 ; backwards compatibility with public-inbox pre-1.2.0,
  28                 ; "inboxdir" takes precedence over "mainrepo"
  29                 mainrepo = /home/user/path/to/test.git
  30
  31 =head2 VARIABLES
  32
  33 =over 8
  34
  35 =item publicinbox.<name>.address
  36
  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.
  42
  43 Default: none, required
  44
  45 =item publicinbox.<name>.inboxdir
  46
  47 The absolute path to the directory which hosts the
  48 public-inbox.  This must be specified once.
  49
  50 This was previously known as "mainrepo", which remains supported,
  51 but "inboxdir" takes precedence.
  52
  53 Default: none, required
  54
  55 =item publicinbox.<name>.url
  56
  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)>
  60
  61 Default: none, optional
  62
  63 =item publicinbox.<name>.newsgroup
  64
  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>
  69
  70 Omitting this for the given inbox will prevent the group from
  71 being read by L<public-inbox-nntpd(1)>
  72
  73 Default: none, optional
  74
  75 =item publicinbox.<name>.watch
  76
  77 A location for L<public-inbox-watch(1)> to watch.  Currently,
  78 only C<maildir:> paths are supported:
  79
  80         [publicinbox "test"]
  81                 watch = maildir:/path/to/maildirs/.INBOX.test/
  82
  83 Default: none; only for L<public-inbox-watch(1)> users
  84
  85 =item publicinbox.<name>.watchheader
  86
  87         [publicinbox "test"]
  88                 watchheader = List-Id:<test.example.com>
  89
  90 If specified, L<public-inbox-watch(1)> will only process mail
  91 matching the given header.  If specified multiple times in
  92 public-inbox 1.5 or later, mail will be processed if it matches
  93 any of the values.  Only the last value was used in public-inbox
  94 1.4 and earlier.
  95
  96 Default: none; only for L<public-inbox-watch(1)> users
  97
  98 =item publicinbox.<name>.listid
  99
 100 The L<rfc2919|https://tools.ietf.org/html/rfc2919> header without
 101 angle brackets for L<public-inbox-mda(1)> deliveries and
 102 L<public-inbox-watch(1)>.
 103
 104 For public-inbox-watch users, this is a shortcut for specifying
 105 C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
 106
 107 For public-inbox-mda users, this may be used to avoid recipient
 108 matching via C<ORIGINAL_RECIPIENT> environment variable.
 109
 110 This may be specified multiple times for merging multiple mailing
 111 lists into a single public-inbox, only one C<List-Id> header
 112 needs to match.
 113
 114 Default: none
 115
 116 =item publicinbox.<name>.nntpmirror
 117
 118 This may be the full NNTP URL of an independently-run mirror.
 119 For example, the https://public-inbox.org/meta/ inbox is
 120 mirrored by Gmane at
 121 C<nntp://news.gmane.io/gmane.mail.public-inbox.general>
 122
 123 Default: none
 124
 125 =item publicinbox.<name>.indexlevel
 126
 127 The indexing level for L<public-inbox-index(1)>
 128
 129 C<basic> only requires L<DBD::SQLite(3pm)> and provides all
 130 NNTP functionality along with thread-awareness in the WWW
 131 interface.
 132
 133 C<medium> requires L<Search::Xapian(3pm)> to provide full-text
 134 term search functionality in the WWW UI.
 135
 136 C<full> also includes positional information used by Xapian to
 137 allow for searching for phrases using quoted text.
 138 (e.g. C<"looking for a complete sentence">)
 139
 140 Default: C<full>
 141
 142 =item publicinbox.<name>.httpbackendmax
 143
 144 If a digit, the maximum number of parallel
 145 L<git-http-backend(1)> processes to allow for cloning this
 146 particular inbox.
 147
 148 If an alphanumeric value starting with a lowercase alphabetic
 149 character is specified, the inbox will use a L</NAMED LIMITER>
 150 which can be shared by multiple inboxes.
 151
 152 Default: 32 (using a default limiter shared by all inboxes)
 153
 154 =item publicinbox.<name>.coderepo
 155
 156 The nickname of a "coderepo" section associated with the inbox.
 157 May be specified more than once for M:N mapping of code repos to
 158 inboxes.  If enabled, diff hunk headers in patch emails will
 159 link to the line numbers of blobs.
 160
 161 Default: none
 162
 163 =item publicinbox.<name>.replyto
 164
 165 May be used to control how reply instructions in the PSGI
 166 interface are displayed.
 167
 168 ":none=dead inbox" may be specified to denote an inactive list
 169 ("dead inbox" may be replaced with another phrase).
 170
 171 A list of comma-delimited email addresses may be specified.
 172 This can be useful for dedicated inboxes for bot emails, but
 173 discussion happens on a separate mailing list/inbox.
 174
 175 Mirrors of existing centralized mailing lists may use ":list"
 176 here to redirect mail only to the configured inbox address.
 177 The use of ":list" is discouraged for new mailing lists, as it
 178 leads to centralization.
 179
 180 Default: :all
 181
 182 =item publicinbox.css
 183
 184 The local path name of a CSS file for the PSGI web interface.
 185 May contain the attributes "media", "title" and "href" which match
 186 the associated attributes of the HTML <style> tag.
 187 "href" may be specified to point to the URL of an remote CSS file
 188 and the path may be "/dev/null" or any empty file.
 189 Multiple files may be specified and will be included in the
 190 order specified.
 191
 192 =item publicinboxmda.spamcheck
 193
 194 This may be set to C<none> to disable the use of SpamAssassin
 195 L<spamc(1)> for filtering spam before it is imported into git
 196 history.  Other spam filtering backends may be supported in
 197 the future.
 198
 199 Default: spamc
 200
 201 =item publicinboxwatch.spamcheck
 202
 203 This may be set to C<spamc> to enable the use of SpamAssassin
 204 L<spamc(1)> for filtering spam before it is imported into git
 205 history.  Other spam filtering backends may be supported in
 206 the future.
 207
 208 This requires L<public-inbox-watch(1)>, but affects all configured
 209 public-inboxes in PI_CONFIG.
 210
 211 Default: none
 212
 213 =item publicinboxwatch.watchspam
 214
 215 A Maildir to watch for confirmed spam messages to appear in.
 216 Messages which appear in this folder with the (S)een Maildir flag
 217 will be hidden from all configured inboxes based on Message-ID
 218 and content matching.
 219
 220 Messages without the (S)een Maildir flag are not considered for hiding.
 221
 222 Default: none; only for L<public-inbox-watch(1)> users
 223
 224 =item publicinbox.nntpserver
 225
 226 Set this to point to the hostname of the L<public-inbox-nntpd(1)>
 227 instance.  This is used to advertise the existence of the NNTP
 228 endpoint in the L<PublicInbox::WWW> HTML interface.
 229
 230 Multiple values are allowed for instances with multiple hostnames
 231 or mirrors.
 232
 233 Default: none
 234
 235 =item publicinbox.<name>.feedmax
 236
 237 The size of an Atom feed for the inbox.  If specified more than
 238 once, only the last value is used.  Invalid values (<= 0) will
 239 be treated as the default value.
 240
 241 Default: 25
 242
 243 =item publicinbox.<name>.hide
 244
 245 A comma-delimited list of listings to hide the inbox from.
 246
 247 Valid values are currently C<www> and C<manifest>.
 248
 249 Default: none
 250
 251 =item coderepo.<nick>.dir
 252
 253 The path to a git repository for "publicinbox.<name>.coderepo"
 254
 255 =item coderepo.<nick>.cgitUrl
 256
 257 The URL of the cgit instance associated with the coderepo.
 258
 259 Default: none
 260
 261 =item publicinbox.cgitrc
 262
 263 A path to a L<cgitrc(5)> file.  "repo.url" directives in the cgitrc
 264 will be mapped to the nickname of a coderepo (without trailing slash),
 265 and "repo.path" directives map to "coderepo.<nick>.dir".
 266 Use of this directive allows admins of existing cgit installations
 267 to skip declaring coderepo sections and map inboxes directly to
 268 code repositories known to cgit.
 269
 270 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
 271
 272 =item publicinbox.cgitbin
 273
 274 A path to the C<cgit.cgi> executable.  The L<PublicInbox::WWW>
 275 interface can spawn cgit as a fallback if the publicinbox.cgitrc
 276 directive is configured.
 277
 278 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
 279
 280 =item publicinbox.cgitdata
 281
 282 A path to the data directory used by cgit for storing static files.
 283 Typically guessed based the location of C<cgit.cgi> (from
 284 C<publicinbox.cgitbin>, but may be overridden.
 285
 286 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
 287 or /usr/share/cgit/
 288
 289 =item publicinbox.mailEditor
 290
 291 See L<public-inbox-edit(1)>
 292
 293 =item publicinbox.indexMaxSize
 294
 295 See L<public-inbox-index(1)>
 296
 297 =item publicinbox.wwwlisting
 298
 299 Enable a HTML listing style when the root path of the URL '/' is accessed.
 300 Valid values are:
 301
 302 =over 8
 303
 304 =item * all
 305 - Show all inboxes
 306
 307 =item * 404
 308 - Return a 404 page.  This is useful to allow customization with
 309 L<Plack::App::Cascade(3pm)>
 310
 311 =item * match=domain
 312 - Only show inboxes with URLs which belong to the domain of the HTTP request
 313
 314 =for TODO comment
 315
 316 support showing cgit listing
 317
 318 =back
 319
 320 Default: C<404>
 321
 322 =item publicinbox.grokmanifest
 323
 324 Controls the generation of a grokmirror-compatible gzipped JSON file
 325 at the top-level of the PSGI interface.  You generally do not need to
 326 change this from the default.
 327
 328 Valid values are:
 329
 330 =over 8
 331
 332 =item * match=domain
 333 - Only include inboxes with URLs which belong to the domain of
 334 the HTTP request.  This is compatible with virtual hosting where
 335 several domains come from the same host.
 336
 337 =item * all
 338 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
 339 Only use this if you're serving HTTP requests in a domain-agnostic manner.
 340
 341 =item * 404
 342 - C<manifest.js.gz> will only contain an empty JSON array.
 343 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
 344 always contain all git repos used by the inbox at C<$INBOX_URL>
 345
 346 =back
 347
 348 Default: C<match=domain>
 349
 350 =back
 351
 352 =head2 NAMED LIMITER (PSGI)
 353
 354 Named limiters are useful for preventing large inboxes from
 355 monopolizing (or overloading) the server.  Since serving git
 356 clones (via L<git-http-backend(1)> can be memory-intensive for
 357 large inboxes, it makes sense to put large inboxes on a named
 358 limiter with a low max value; while smaller inboxes can use
 359 the default limiter.
 360
 361 C<RLIMIT_*> keys may be set to enforce resource limits for
 362 a particular limiter.
 363
 364 Default named-limiters are prefixed with "-".  Currently,
 365 the "-cgit" named limiter is reserved for instances spawning
 366 cgit via C<publicinbox.cgitrc>
 367
 368 =over 8
 369
 370 =item publicinboxlimiter.<name>.max
 371
 372 The maximum number of parallel processes for the given limiter.
 373
 374 =item publicinboxlimiter.<name>.rlimitCore
 375
 376 =item publicinboxlimiter.<name>.rlimitCPU
 377
 378 =item publicinboxlimiter.<name>.rlimitData
 379
 380 The maximum core size, CPU time, or data size processes run with the
 381 given limiter will use.  This may be comma-separated to distinguish
 382 soft and hard limits.  The word "INFINITY" is accepted as the
 383 RLIM_INFINITY constant (if supported by your OS).
 384
 385 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
 386 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
 387
 388 =back
 389
 390 =head3 EXAMPLE WITH NAMED LIMITERS
 391
 392         ; big inboxes which require lots of memory to clone:
 393         [publicinbox "big1"]
 394                 inboxdir = /path/to/big1
 395                 address = big1@example.com
 396                 httpbackendmax = big
 397         [publicinbox "big2"]
 398                 inboxdir = /path/to/big2
 399                 address = big2@example.com
 400                 httpbackendmax = big
 401
 402         ; tiny inboxes which are easily cloned:
 403         [publicinbox "tiny1"]
 404                 inboxdir = /path/to/tiny1
 405                 address = tiny1@example.com
 406         [publicinbox "tiny2"]
 407                 inboxdir = /path/to/tiny2
 408                 address = tiny2@example.com
 409
 410         [publicinboxlimiter "big"]
 411                 max = 4
 412
 413 In the above example, the "big1" and "big2" are limited to four
 414 parallel L<git-http-backend(1)> processes between them.
 415
 416 However, "tiny1" and "tiny2" will share the default limiter
 417 which means there can be 32 L<git-http-backend(1)> processes
 418 between them.
 419
 420 =head1 ENVIRONMENT
 421
 422 =over 8
 423
 424 =item PI_CONFIG
 425
 426 Used to override the default "~/.public-inbox/config" value.
 427
 428 =back
 429
 430 =head1 CONTACT
 431
 432 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 433
 434 The mail archives are hosted at L<https://public-inbox.org/meta/>
 435 and L<http://hjrcffqmbrq6wope.onion/meta/>
 436
 437 =head1 COPYRIGHT
 438
 439 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
 440
 441 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 442
 443 =head1 SEE ALSO
 444
 445 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
 446 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
 447 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>