From 060c0c6ba3469233cb6dba067d397a30113df272 Mon Sep 17 00:00:00 2001
From: "Christian P. MOMON" <christian.momon@devinsy.fr>
Date: Mon, 19 Aug 2024 00:17:27 +0200
Subject: [PATCH] Add cache doc in README.

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index b54ce5b..677a72b 100644
--- a/README.md
+++ b/README.md
@@ -148,3 +148,21 @@ Add a dedicated `host` section in `/etc/tomcat10/server.xml`:
 
 The `cache` directory must be readable by Tomcat.
 
+## About page caching
+
+The web pages are put in a HTML cache so they are not build again at each request.
+
+The HTML cache is automatically clear when the data directory is modified. The reload is quick.
+
+However, the organizations and services metrics pages are in cache. Just because the combinatorial is too large!
+
+Example:
+
+- (Summary,Generic,Specific,Web) x (Month, Weeks) x (ALL, last months, year1-year4) = 48 pages by item
+- 100 organizations + 300 services = 400 items
+- 400 items x 48 pages => ~20 000 pages
+- 200kB/page => 4GB in memory
+
+Metrics pages are so numerous than they have to build on demand.
+
+