changeset 8445:0bca9e828db2 stable

docs: mention the need for worker process restarts to avoid "memory leaks" (Issue #346) It might not be ideal to mention such details in the overview, but that seems like the best place for generic advice. (Kallithea should still aim for keeping memory growth under control.)
author Mads Kiilerich <mads@kiilerich.com>
date Thu, 11 Jun 2020 20:50:26 +0200
parents 850f096505ac
children 881d2bd97973 d1521d421610 a04d6926d694
files docs/overview.rst
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/overview.rst	Thu Jun 11 20:16:32 2020 +0200
+++ b/docs/overview.rst	Thu Jun 11 20:50:26 2020 +0200
@@ -204,6 +204,14 @@
 also often used inside organizations with a limited amount of users and thus no
 continuous hammering from the internet.
 
+.. note::
+   Kallithea, the libraries it uses, and Python itself do in several places use
+   simple caching in memory. Caches and memory are not always released in a way
+   that is suitable for long-running processes. They might appear to be leaking
+   memory. The worker processes should thus regularly be restarted - for
+   example after 1000 requests and/or one hour. This can usually be done by the
+   web server or the tool used for running it as a system service.
+
 
 .. _Python: http://www.python.org/
 .. _Gunicorn: http://gunicorn.org/