soutade/iwla
1
0
Fork 0
Code Issues Pull Requests Releases 2 Activity

Update documentation

Browse Source
This commit is contained in:
Grégory Soutadé 2022-11-20 10:18:11 +01:00
parent 7e2991aa50
commit 2b19a009e8
2 changed files with 64 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/index.md
View File

@ -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

34
docs/modules.md
View File

@ -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