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 matching
  91 the given header.  Multiple values are not currently supported.
  92
  93 Default: none; only for L<public-inbox-watch(1)> users
  94
  95 =item publicinbox.<name>.listid
  96
  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)>.
 100
 101 For public-inbox-watch users, this is a shortcut for specifying
 102 C<publicinbox.$NAME.watchheader=List-Id:<foo.example.com>>
 103
 104 For public-inbox-mda users, this may be used to avoid recipient
 105 matching via C<ORIGINAL_RECIPIENT> environment variable.
 106
 107 This may be specified multiple times for merging multiple mailing
 108 lists into a single public-inbox, only one C<List-Id> header
 109 needs to match.
 110
 111 Default: none
 112
 113 =item publicinbox.<name>.nntpmirror
 114
 115 This may be the full NNTP URL of an independently-run mirror.
 116 For example, the https://public-inbox.org/meta/ inbox is
 117 mirrored by Gmane at
 118 C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
 119
 120 Default: none
 121
 122 =item publicinbox.<name>.indexlevel
 123
 124 The indexing level for L<public-inbox-index(1)>
 125
 126 C<basic> only requires L<DBD::SQLite(3pm)> and provides all
 127 NNTP functionality along with thread-awareness in the WWW
 128 interface.
 129
 130 C<medium> requires L<Search::Xapian(3pm)> to provide full-text
 131 term search functionality in the WWW UI.
 132
 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">)
 136
 137 Default: C<full>
 138
 139 =item publicinbox.<name>.httpbackendmax
 140
 141 If a digit, the maximum number of parallel
 142 L<git-http-backend(1)> processes to allow for cloning this
 143 particular inbox.
 144
 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.
 148
 149 Default: 32 (using a default limiter shared by all inboxes)
 150
 151 =item publicinbox.<name>.coderepo
 152
 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.
 157
 158 Default: none
 159
 160 =item publicinbox.<name>.replyto
 161
 162 May be used to control how reply instructions in the PSGI
 163 interface are displayed.
 164
 165 ":none=dead inbox" may be specified to denote an inactive list
 166 ("dead inbox" may be replaced with another phrase).
 167
 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 seperate mailing list/inbox.
 171
 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.
 176
 177 Default: :all
 178
 179 =item publicinbox.css
 180
 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
 187 order specified.
 188
 189 =item publicinboxmda.spamcheck
 190
 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
 194 the future.
 195
 196 Default: spamc
 197
 198 =item publicinboxwatch.spamcheck
 199
 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
 203 the future.
 204
 205 Default: none
 206
 207 =item publicinboxwatch.watchspam
 208
 209 This may be set to C<spamc> to enable the use of SpamAssassin
 210 L<spamc(1)> for filtering spam before it is imported into git
 211 history.  Other spam filtering backends may be supported in
 212 the future.  This requires L<public-inbox-watch(1)>, but affects
 213 all configured public-inboxes in PI_CONFIG.
 214
 215 Default: none
 216
 217 =item publicinbox.nntpserver
 218
 219 Set this to point to the address of the L<public-inbox-nntpd(1)>
 220 instance.  This is used to advertise the existence of the NNTP
 221 presnce in the L<PublicInbox::WWW> HTML interface.
 222
 223 Multiple values are allowed for servers with multiple
 224 addresses or mirrors.
 225
 226 Default: none
 227
 228 =item publicinbox.<name>.feedmax
 229
 230 The size of an Atom feed for the inbox.  If specified more than
 231 once, only the last value is used.  Invalid values (<= 0) will
 232 be treated as the default value.
 233
 234 Default: 25
 235
 236 =item publicinbox.<name>.hide
 237
 238 A comma-delimited list of listings to hide the inbox from.
 239
 240 Valid values are currently C<www> and C<manifest>.
 241
 242 Default: none
 243
 244 =item coderepo.<nick>.dir
 245
 246 The path to a git repository for "publicinbox.<name>.coderepo"
 247
 248 =item coderepo.<nick>.cgitUrl
 249
 250 The URL of the cgit instance associated with the coderepo.
 251
 252 Default: none
 253
 254 =item publicinbox.cgitrc
 255
 256 A path to a L<cgitrc(5)> file.  "repo.url" directives in the cgitrc
 257 will be mapped to the nickname of a coderepo (without trailing slash),
 258 and "repo.path" directives map to "coderepo.<nick>.dir".
 259 Use of this directive allows admins of existing cgit installations
 260 to skip declaring coderepo sections and map inboxes directly to
 261 code repositories known to cgit.
 262
 263 Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.
 264
 265 =item publicinbox.cgitbin
 266
 267 A path to the C<cgit.cgi> executable.  The L<PublicInbox::WWW>
 268 interface can spawn cgit as a fallback if the publicinbox.cgitrc
 269 directive is configured.
 270
 271 Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi
 272
 273 =item publicinbox.cgitdata
 274
 275 A path to the data directory used by cgit for storing static files.
 276 Typically guessed based the location of C<cgit.cgi> (from
 277 C<publicinbox.cgitbin>, but may be overridden.
 278
 279 Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/
 280 or /usr/share/cgit/
 281
 282 =item publicinbox.mailEditor
 283
 284 See L<public-inbox-edit(1)>
 285
 286 =item publicinbox.wwwlisting
 287
 288 Enable a HTML listing style when the root path of the URL '/' is accessed.
 289 Valid values are:
 290
 291 =over 8
 292
 293 =item * all
 294 - Show all inboxes
 295
 296 =item * 404
 297 - Return a 404 page.  This is useful to allow customization with
 298 L<Plack::App::Cascade(3pm)>
 299
 300 =item * match=domain
 301 - Only show inboxes with URLs which belong to the domain of the HTTP request
 302
 303 =for TODO comment
 304
 305 support showing cgit listing
 306
 307 =back
 308
 309 Default: C<404>
 310
 311 =item publicinbox.grokmanifest
 312
 313 Controls the generation of a grokmirror-compatible gzipped JSON file
 314 at the top-level of the PSGI interface.  You generally do not need to
 315 change this from the default.
 316
 317 Valid values are:
 318
 319 =over 8
 320
 321 =item * match=domain
 322 - Only include inboxes with URLs which belong to the domain of
 323 the HTTP request.  This is compatible with virtual hosting where
 324 several domains come from the same host.
 325
 326 =item * all
 327 - All inboxes are present in C<manifest.js.gz>, regardless of domain.
 328 Only use this if you're serving HTTP requests in a domain-agnostic manner.
 329
 330 =item * 404
 331 - C<manifest.js.gz> will only contain an empty JSON array.
 332 This does NOT affect C<$INBOX_URL/manifest.js.gz>, which will
 333 always contain all git repos used by the inbox at C<$INBOX_URL>
 334
 335 =back
 336
 337 Default: C<match=domain>
 338
 339 =back
 340
 341 =head2 NAMED LIMITER (PSGI)
 342
 343 Named limiters are useful for preventing large inboxes from
 344 monopolizing (or overloading) the server.  Since serving git
 345 clones (via L<git-http-backend(1)> can be memory-intensive for
 346 large inboxes, it makes sense to put large inboxes on a named
 347 limiter with a low max value; while smaller inboxes can use
 348 the default limiter.
 349
 350 C<RLIMIT_*> keys may be set to enforce resource limits for
 351 a particular limiter.
 352
 353 Default named-limiters are prefixed with "-".  Currently,
 354 the "-cgit" named limiter is reserved for instances spawning
 355 cgit via C<publicinbox.cgitrc>
 356
 357 =over 8
 358
 359 =item publicinboxlimiter.<name>.max
 360
 361 The maximum number of parallel processes for the given limiter.
 362
 363 =item publicinboxlimiter.<name>.rlimitCore
 364
 365 =item publicinboxlimiter.<name>.rlimitCPU
 366
 367 =item publicinboxlimiter.<name>.rlimitData
 368
 369 The maximum core size, CPU time, or data size processes run with the
 370 given limiter will use.  This may be comma-separated to distinguish
 371 soft and hard limits.  The word "INFINITY" is accepted as the
 372 RLIM_INFINITY constant (if supported by your OS).
 373
 374 See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
 375 RLIMIT_CPU, and RLIMIT_DATA for you operating system.
 376
 377 =back
 378
 379 =head3 EXAMPLE WITH NAMED LIMITERS
 380
 381         ; big inboxes which require lots of memory to clone:
 382         [publicinbox "big1"]
 383                 inboxdir = /path/to/big1
 384                 address = big1@example.com
 385                 httpbackendmax = big
 386         [publicinbox "big2"]
 387                 inboxdir = /path/to/big2
 388                 address = big2@example.com
 389                 httpbackendmax = big
 390
 391         ; tiny inboxes which are easily cloned:
 392         [publicinbox "tiny1"]
 393                 inboxdir = /path/to/tiny1
 394                 address = tiny1@example.com
 395         [publicinbox "tiny2"]
 396                 inboxdir = /path/to/tiny2
 397                 address = tiny2@example.com
 398
 399         [publicinboxlimiter "big"]
 400                 max = 4
 401
 402 In the above example, the "big1" and "big2" are limited to four
 403 parallel L<git-http-backend(1)> processes between them.
 404
 405 However, "tiny1" and "tiny2" will share the default limiter
 406 which means there can be 32 L<git-http-backend(1)> processes
 407 between them.
 408
 409 =head1 ENVIRONMENT
 410
 411 =over 8
 412
 413 =item PI_CONFIG
 414
 415 Used to override the default "~/.public-inbox/config" value.
 416
 417 =back
 418
 419 =head1 CONTACT
 420
 421 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 422
 423 The mail archives are hosted at L<https://public-inbox.org/meta/>
 424 and L<http://hjrcffqmbrq6wope.onion/meta/>
 425
 426 =head1 COPYRIGHT
 427
 428 Copyright 2016-2019 all contributors L<mailto:meta@public-inbox.org>
 429
 430 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 431
 432 =head1 SEE ALSO
 433
 434 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
 435 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>,
 436 L<grokmirror|https://git.kernel.org/pub/scm/utils/grokmirror/grokmirror.git>