From 2b19a009e8746984272433d9e1501fe552edf0ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9gory=20Soutad=C3=A9?= Date: Sun, 20 Nov 2022 10:18:11 +0100 Subject: [PATCH] Update documentation --- docs/index.md | 34 ++++++++++++++++++++++++++++++++-- docs/modules.md | 34 ++++++++++++++++++++++++++++++++-- 2 files changed, 64 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 79ca06c..ef8e1a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -109,6 +109,7 @@ Plugins Optional configuration values ends with *. * iwla.py + * plugins/display/all_visits_enlight.py * plugins/display/all_visits.py * plugins/display/browsers.py * plugins/display/feeds.py @@ -233,6 +234,34 @@ iwla None +plugins.display.all_visits_enlight +---------------------------------- + + Display hook + + Enlight users in all visits page if visitor['enlight'] property is True + or user is filtered + Can be set in filter users callback + + Plugin requirements : + IWLADisplayAllVisits + + Conf values needed : + None + + Output files : + None + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.all_visits -------------------------- @@ -758,7 +787,7 @@ plugins.post_analysis.feeds Post analysis hook Find feeds parsers (first hit in feeds conf value and no viewed pages if it's a robot) - If there is ony one hit per day to a feed, merge feeds parsers with the same user agent + If merge_feeds_parsers is set to True, merge feeds parsers with the same user agent as it must be the same person with a different IP address. Plugin requirements : @@ -767,7 +796,7 @@ plugins.post_analysis.feeds Conf values needed : feeds feeds_referers* - merge_one_hit_only_feeds_parsers* + merge_feeds_parsers* Output files : None @@ -775,6 +804,7 @@ plugins.post_analysis.feeds Statistics creation : remote_addr => feed_parser + feed_name_analysed Statistics update : None diff --git a/docs/modules.md b/docs/modules.md index ce5c42c..d5bc7f0 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -1,4 +1,5 @@ * iwla.py + * plugins/display/all_visits_enlight.py * plugins/display/all_visits.py * plugins/display/browsers.py * plugins/display/feeds.py @@ -123,6 +124,34 @@ iwla None +plugins.display.all_visits_enlight +---------------------------------- + + Display hook + + Enlight users in all visits page if visitor['enlight'] property is True + or user is filtered + Can be set in filter users callback + + Plugin requirements : + IWLADisplayAllVisits + + Conf values needed : + None + + Output files : + None + + Statistics creation : + None + + Statistics update : + None + + Statistics deletion : + None + + plugins.display.all_visits -------------------------- @@ -648,7 +677,7 @@ plugins.post_analysis.feeds Post analysis hook Find feeds parsers (first hit in feeds conf value and no viewed pages if it's a robot) - If there is ony one hit per day to a feed, merge feeds parsers with the same user agent + If merge_feeds_parsers is set to True, merge feeds parsers with the same user agent as it must be the same person with a different IP address. Plugin requirements : @@ -657,7 +686,7 @@ plugins.post_analysis.feeds Conf values needed : feeds feeds_referers* - merge_one_hit_only_feeds_parsers* + merge_feeds_parsers* Output files : None @@ -665,6 +694,7 @@ plugins.post_analysis.feeds Statistics creation : remote_addr => feed_parser + feed_name_analysed Statistics update : None