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 C<.>.
  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>.indexSequentialShard
 143
 144 See L<public-inbox-index(1)/publicInbox.indexSequentialShard>
 145
 146 =item publicinbox.<name>.httpbackendmax
 147
 148 If a digit, the maximum number of parallel
 149 L<git-http-backend(1)> processes to allow for cloning this
 150 particular inbox.
 151
 152 If an alphanumeric value starting with a lowercase alphabetic
 153 character is specified, the inbox will use a L</NAMED LIMITER>
 154 which can be shared by multiple inboxes.
 155
 156 Default: 32 (using a default limiter shared by all inboxes)
 157
 158 =item publicinbox.<name>.coderepo
 159
 160 The nickname of a "coderepo" section associated with the inbox.
 161 May be specified more than once for M:N mapping of code repos to
 162 inboxes.  If enabled, diff hunk headers in patch emails will
 163 link to the line numbers of blobs.
 164
 165 Default: none
 166
 167 =item publicinbox.<name>.replyto
 168
 169 May be used to control how reply instructions in the PSGI
 170 interface are displayed.
 171
 172 ":none=dead inbox" may be specified to denote an inactive list
 173 ("dead inbox" may be replaced with another phrase).
 174
 175 A list of comma-delimited email addresses may be specified.
 176 This can be useful for dedicated inboxes for bot emails, but
 177 discussion happens on a separate mailing list/inbox.
 178
 179 Mirrors of existing centralized mailing lists may use ":list"
 180 here to redirect mail only to the configured inbox address.
 181 The use of ":list" is discouraged for new mailing lists, as it
 182 leads to centralization.
 183
 184 Default: :all
 185
 186 =item publicinbox.css
 187
 188 The local path name of a CSS file for the PSGI web interface.
 189 May contain the attributes "media", "title" and "href" which match
 190 the associated attributes of the HTML <style> tag.
 191 "href" may be specified to point to the URL of an remote CSS file
 192 and the path may be "/dev/null" or any empty file.
 193 Multiple files may be specified and will be included in the
 194 order specified.
 195
 196 =item publicinboxmda.spamcheck
 197
 198 This may be set to C<none> to disable the use of SpamAssassin
 199 L<spamc(1)> for filtering spam before it is imported into git
 200 history.  Other spam filtering backends may be supported in
 201 the future.
 202
 203 Default: spamc
 204
 205 =item publicinboxwatch.spamcheck
 206
 207 This may be set to C<spamc> to enable the use of SpamAssassin
 208 L<spamc(1)> for filtering spam before it is imported into git
 209 history.  Other spam filtering backends may be supported in
 210 the future.
 211
 212 This requires L<public-inbox-watch(1)>, but affects all configured
 213 public-inboxes in PI_CONFIG.
 214
 215 Default: none
 216
 217 =item publicinboxwatch.watchspam
 218
 219 A Maildir to watch for confirmed spam messages to appear in.
 220 Messages which appear in this folder with the (S)een Maildir flag
 221 will be hidden from all configured inboxes based on Message-ID
 222 and content matching.
 223
 224 Messages without the (S)een Maildir flag are not considered for hiding.
 225
 226 Default: none; only for L<public-inbox-watch(1)> users
 227
 228 =item publicinbox.nntpserver
 229
 230 Set this to point to the hostname of the L<public-inbox-nntpd(1)>
 231 instance.  This is used to advertise the existence of the NNTP
 232 endpoint in the L<PublicInbox::WWW> HTML interface.
 233
 234 Multiple values are allowed for instances with multiple hostnames
 235 or mirrors.
 236
 237 Default: none
 238
 239 =item publicinbox.<name>.feedmax
 240
 241 The size of an Atom feed for the inbox.  If specified more than
 242 once, only the last value is used.  Invalid values (<= 0) will
 243 be treated as the default value.
 244
 245 Default: 25
 246
 247 =item publicinbox.<name>.hide
 248
 249 A comma-delimited list of listings to hide the inbox from.
 250
 251 Valid values are currently C<www> and C<manifest>.
 252
 253 Default: none
 254
 255 =item coderepo.<nick>.dir
 256
 257 The path to a git repository for "publicinbox.<name>.coderepo"
 258
 259 =item coderepo.<nick>.cgitUrl
 260
 261 The URL of the cgit instance associated with the coderepo.
 262
 263 Default: none
 264
 265 =item publicinbox.cgitrc
 266
 267 A path to a L<cgitrc(5)> file.  "repo.url" directives in the cgitrc
 268 will be mapped to the nickname of a coderepo (without trailing slash),
 269 and "repo.path" directives map to "coderepo.<nick>.dir".
 270 Use of this directive allows admins of existing cgit installations
 271 to skip declaring coderepo sections and map inboxes directly to
 272 code repositories known to cgit.
 273
 274 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
 275
 276 =item publicinbox.cgitbin
 277
 278 A path to the C<cgit.cgi> executable.  The L<PublicInbox::WWW>
 279 interface can spawn cgit as a fallback if the publicinbox.cgitrc
 280 directive is configured.
 281
 282 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
 283
 284 =item publicinbox.cgitdata
 285
 286 A path to the data directory used by cgit for storing static files.
 287 Typically guessed based the location of C<cgit.cgi> (from
 288 C<publicinbox.cgitbin>, but may be overridden.
 289
 290 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
 291 or /usr/share/cgit/
 292
 293 =item publicinbox.mailEditor
 294
 295 See L<public-inbox-edit(1)>
 296
 297 =item publicinbox.indexMaxSize
 298 =item publicinbox.indexBatchSize
 299 =item publicinbox.indexSequentialShard
 300
 301 See L<public-inbox-index(1)>
 302
 303 =item publicinbox.wwwlisting
 304
 305 Enable a HTML listing style when the root path of the URL '/' is accessed.
 306 Valid values are:
 307
 308 =over 8
 309
 310 =item * all
 311 - Show all inboxes
 312
 313 =item * 404
 314 - Return a 404 page.  This is useful to allow customization with
 315 L<Plack::App::Cascade(3pm)>
 316
 317 =item * match=domain
 318 - Only show inboxes with URLs which belong to the domain of the HTTP request
 319
 320 =for TODO comment
 321
 322 support showing cgit listing
 323
 324 =back
 325
 326 Default: C<404>
 327
 328 =item publicinbox.grokmanifest
 329
 330 Controls the generation of a grokmirror-compatible gzipped JSON file
 331 at the top-level of the PSGI interface.  You generally do not need to
 332 change this from the default.
 333
 334 Valid values are:
 335
 336 =over 8
 337
 338 =item * match=domain
 339 - Only include inboxes with URLs which belong to the domain of
 340 the HTTP request.  This is compatible with virtual hosting where
 341 several domains come from the same host.
 342
 343 =item * all
 344 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
 345 Only use this if you're serving HTTP requests in a domain-agnostic manner.
 346
 347 =item * 404
 348 - C<manifest.js.gz> will only contain an empty JSON array.
 349 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
 350 always contain all git repos used by the inbox at C<$INBOX_URL>
 351
 352 =back
 353
 354 Default: C<match=domain>
 355
 356 =back
 357
 358 =head2 NAMED LIMITER (PSGI)
 359
 360 Named limiters are useful for preventing large inboxes from
 361 monopolizing (or overloading) the server.  Since serving git
 362 clones (via L<git-http-backend(1)> can be memory-intensive for
 363 large inboxes, it makes sense to put large inboxes on a named
 364 limiter with a low max value; while smaller inboxes can use
 365 the default limiter.
 366
 367 C<RLIMIT_*> keys may be set to enforce resource limits for
 368 a particular limiter.
 369
 370 Default named-limiters are prefixed with "-".  Currently,
 371 the "-cgit" named limiter is reserved for instances spawning
 372 cgit via C<publicinbox.cgitrc>
 373
 374 =over 8
 375
 376 =item publicinboxlimiter.<name>.max
 377
 378 The maximum number of parallel processes for the given limiter.
 379
 380 =item publicinboxlimiter.<name>.rlimitCore
 381
 382 =item publicinboxlimiter.<name>.rlimitCPU
 383
 384 =item publicinboxlimiter.<name>.rlimitData
 385
 386 The maximum core size, CPU time, or data size processes run with the
 387 given limiter will use.  This may be comma-separated to distinguish
 388 soft and hard limits.  The word "INFINITY" is accepted as the
 389 RLIM_INFINITY constant (if supported by your OS).
 390
 391 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
 392 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
 393
 394 =back
 395
 396 =head3 EXAMPLE WITH NAMED LIMITERS
 397
 398         ; big inboxes which require lots of memory to clone:
 399         [publicinbox "big1"]
 400                 inboxdir = /path/to/big1
 401                 address = big1@example.com
 402                 httpbackendmax = big
 403         [publicinbox "big2"]
 404                 inboxdir = /path/to/big2
 405                 address = big2@example.com
 406                 httpbackendmax = big
 407
 408         ; tiny inboxes which are easily cloned:
 409         [publicinbox "tiny1"]
 410                 inboxdir = /path/to/tiny1
 411                 address = tiny1@example.com
 412         [publicinbox "tiny2"]
 413                 inboxdir = /path/to/tiny2
 414                 address = tiny2@example.com
 415
 416         [publicinboxlimiter "big"]
 417                 max = 4
 418
 419 In the above example, the "big1" and "big2" are limited to four
 420 parallel L<git-http-backend(1)> processes between them.
 421
 422 However, "tiny1" and "tiny2" will share the default limiter
 423 which means there can be 32 L<git-http-backend(1)> processes
 424 between them.
 425
 426 =head1 ENVIRONMENT
 427
 428 =over 8
 429
 430 =item PI_CONFIG
 431
 432 Used to override the default "~/.public-inbox/config" value.
 433
 434 =back
 435
 436 =head1 CONTACT
 437
 438 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 439
 440 The mail archives are hosted at L<https://public-inbox.org/meta/>
 441 and L<http://hjrcffqmbrq6wope.onion/meta/>
 442
 443 =head1 COPYRIGHT
 444
 445 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
 446
 447 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 448
 449 =head1 SEE ALSO
 450
 451 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
 452 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
 453 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>