From 229e80a9a588aec3991be009dfb22ae29147312b Mon Sep 17 00:00:00 2001
From: Gregory Soutade <gregory@soutade.fr>
Date: Thu, 3 Jun 2021 09:00:45 +0200
Subject: [PATCH] Update documentation

---
 docs/index.md   | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 docs/modules.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 94 insertions(+)

diff --git a/docs/index.md b/docs/index.md
index 7b72d1a..ac461ad 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -104,6 +104,7 @@ Optional configuration values ends with *.
   * plugins/display/all_visits.py
   * plugins/display/browsers.py
   * plugins/display/feeds.py
+  * plugins/display/filter_users.py
   * plugins/display/hours_stats.py
   * plugins/display/ip_to_geo.py
   * plugins/display/istats_diff.py
@@ -123,6 +124,7 @@ Optional configuration values ends with *.
   * plugins/post_analysis/hours_stats.py
   * plugins/post_analysis/ip_to_geo.py
   * plugins/post_analysis/iptogeo.py
+  * plugins/post_analysis/iptogeo.reset.py
   * plugins/post_analysis/operating_systems.py
   * plugins/post_analysis/referers.py
   * plugins/post_analysis/reverse_dns.py
@@ -305,6 +307,45 @@ plugins.display.feeds
         None
 
 
+plugins.display.filter_users
+----------------------------
+
+    Display hook
+    
+    Filter users
+    
+    Plugin requirements :
+        None
+    
+    Conf values needed :
+        filtered_users : list of filters
+        filtered_ip : list of ip (string)
+        create_filtered_page*
+    
+    Filter is a list of filter description combined by AND operator
+    Filter description is a list of 3 elements :
+    
+      * Field to match in visits
+      * Operator '=', '==', '!=', '>', '>=', '<', '<=' for int value
+      * Operator '=', '==', '!=', 'in', 'match' for str value
+      * Target value
+    
+    For easiest config, you can indicate both 'remote_addr' or 'ip' in field element
+    
+    Output files :
+        OUTPUT_ROOT/year/month/index.html
+        OUTPUT_ROOT/year/month/filtered_users.html
+    
+    Statistics creation :
+        None
+    
+    Statistics update :
+        None
+    
+    Statistics deletion :
+        None
+
+
 plugins.display.hours_stats
 ---------------------------
 
@@ -730,6 +771,7 @@ plugins.post_analysis.feeds
     
     Conf values needed :
         feeds
+        feeds_referers*
         merge_one_hit_only_feeds_parsers*
     
     Output files :
@@ -818,6 +860,11 @@ plugins.post_analysis.iptogeo
 
 
 
+plugins.post_analysis.iptogeo.reset
+-----------------------------------
+
+
+
 plugins.post_analysis.operating_systems
 ---------------------------------------
 
diff --git a/docs/modules.md b/docs/modules.md
index ee1dd11..59eab32 100644
--- a/docs/modules.md
+++ b/docs/modules.md
@@ -2,6 +2,7 @@
   * plugins/display/all_visits.py
   * plugins/display/browsers.py
   * plugins/display/feeds.py
+  * plugins/display/filter_users.py
   * plugins/display/hours_stats.py
   * plugins/display/ip_to_geo.py
   * plugins/display/istats_diff.py
@@ -21,6 +22,7 @@
   * plugins/post_analysis/hours_stats.py
   * plugins/post_analysis/ip_to_geo.py
   * plugins/post_analysis/iptogeo.py
+  * plugins/post_analysis/iptogeo.reset.py
   * plugins/post_analysis/operating_systems.py
   * plugins/post_analysis/referers.py
   * plugins/post_analysis/reverse_dns.py
@@ -203,6 +205,45 @@ plugins.display.feeds
         None
 
 
+plugins.display.filter_users
+----------------------------
+
+    Display hook
+    
+    Filter users
+    
+    Plugin requirements :
+        None
+    
+    Conf values needed :
+        filtered_users : list of filters
+        filtered_ip : list of ip (string)
+        create_filtered_page*
+    
+    Filter is a list of filter description combined by AND operator
+    Filter description is a list of 3 elements :
+    
+      * Field to match in visits
+      * Operator '=', '==', '!=', '>', '>=', '<', '<=' for int value
+      * Operator '=', '==', '!=', 'in', 'match' for str value
+      * Target value
+    
+    For easiest config, you can indicate both 'remote_addr' or 'ip' in field element
+    
+    Output files :
+        OUTPUT_ROOT/year/month/index.html
+        OUTPUT_ROOT/year/month/filtered_users.html
+    
+    Statistics creation :
+        None
+    
+    Statistics update :
+        None
+    
+    Statistics deletion :
+        None
+
+
 plugins.display.hours_stats
 ---------------------------
 
@@ -628,6 +669,7 @@ plugins.post_analysis.feeds
     
     Conf values needed :
         feeds
+        feeds_referers*
         merge_one_hit_only_feeds_parsers*
     
     Output files :
@@ -716,6 +758,11 @@ plugins.post_analysis.iptogeo
 
 
 
+plugins.post_analysis.iptogeo.reset
+-----------------------------------
+
+
+
 plugins.post_analysis.operating_systems
 ---------------------------------------