X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-config.pod;h=d44c8f30777adb03c04f63e4fab121938a2da0d6;hb=e1ed79d1e99e2c58b3edb370e60904cf656dd823;hp=23ebcc5fc6c1655e478ba8800f314a4f32741c99;hpb=218d723d6e52d3ff5627bd55ae418ac6d2763dc6;p=public-inbox.git diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 23ebcc5f..d44c8f30 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -91,6 +91,18 @@ C Default: none +=item publicinbox..httpbackendmax + +If a digit, the maximum number of parallel +L 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 +which can be shared by multiple inboxes. + +Default: 32 (using a default limiter shared by all inboxes) + =item publicinbox..coderepo The nickname of a "coderepo" section associated with the inbox. @@ -100,6 +112,25 @@ link to the line numbers of blobs. Default: none +=item publicinbox..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 seperate 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. @@ -157,18 +188,151 @@ be treated as the default value. Default: 25 -=item coderepo..dir +=item publicinbox..hide + +A comma-delimited list of listings to hide the inbox from. + +Valid values are currently "www". + +Default: none + +=item coderepo..dir The path to a git repository for "publicinbox..coderepo" -=item coderepo..cgitUrl +=item coderepo..cgitUrl The URL of the cgit instance associated with the coderepo. Default: none +=item publicinbox.cgitrc + +A path to a L 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..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 executable. The L +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 the location of C (from +C, but may be overridden. + +Default: basename of C, /var/www/htdocs/cgit/ +or /usr/share/cgit/ + +=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 + +=item match=domain + +Only show inboxes with URLs which belong to the domain of the HTTP +request + +=for TODO comment + +support showing cgit listing + +=back + +Default: 404 + =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 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 keys may be set to enforce resource limits for +a particular limiter. + +Default named-limiters are prefixed with "-". Currently, +the "-cgit" named limiter is reserved for instances spawning +cgit via C + +=over 8 + +=item publicinboxlimiter..max + +The maximum number of parallel processes for the given limiter. + +=item publicinboxlimiter..rlimitCore + +=item publicinboxlimiter..rlimitCPU + +=item publicinboxlimiter..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 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"] + mainrepo = /path/to/big1 + address = big1@example.com + httpbackendmax = big + [publicinbox "big2"] + mainrepo = /path/to/big2 + address = big2@example.com + httpbackendmax = big + + ; tiny inboxes which are easily cloned: + [publicinbox "tiny1"] + mainrepo = /path/to/tiny1 + address = tiny1@example.com + [publicinbox "tiny2"] + mainrepo = /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 processes between them. + +However, "tiny1" and "tiny2" will share the default limiter +which means there can be 32 L processes +between them. + =head1 ENVIRONMENT =over 8