about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2019-01-31 08:52:49 +0000
committerEric Wong <e@80x24.org>2019-01-31 08:55:44 +0000
commit0608470d1f1ecd2cbf92c52313992a1c6dbebab2 (patch)
tree7f8cd6cfcf50720d426d7da378caa05626326f68 /Documentation
parent5b9808f2a93a94c86b8b05a54270007973f88313 (diff)
I've relied on this feature to keep the VPS behind
https://public-inbox.org/git/ from OOM-ing since 2016,
so document it to ensure others can make use of low-end
servers like I do.

More limiters may become configurable for viewvcs and
solver functionality (or we continue using the default
Diffstat (limited to 'Documentation')
1 files changed, 59 insertions, 0 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 23ebcc5f..cad0c4ee 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -91,6 +91,18 @@ C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
 Default: none
+=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.
@@ -169,6 +181,53 @@ Default: none
+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.
+=over 8
+=item publicinboxlimiter.<name>.max
+The maximum number of parallel processes for the given limiter.
+        ; 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<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.
 =over 8