Update documentation

This commit is contained in:
Grégory Soutadé 2023-04-18 20:37:33 +02:00
parent b1e6f973a6
commit b1b92412e0
2 changed files with 240 additions and 2 deletions

View File

@ -116,11 +116,13 @@ Optional configuration values ends with *.
* plugins/display/filter_users.py * plugins/display/filter_users.py
* plugins/display/hours_stats.py * plugins/display/hours_stats.py
* plugins/display/ip_to_geo.py * plugins/display/ip_to_geo.py
* plugins/display/ip_type.py
* plugins/display/istats_diff.py * plugins/display/istats_diff.py
* plugins/display/operating_systems.py * plugins/display/operating_systems.py
* plugins/display/referers_diff.py * plugins/display/referers_diff.py
* plugins/display/referers.py * plugins/display/referers.py
* plugins/display/robot_bandwidth.py * plugins/display/robot_bandwidth.py
* plugins/display/subdomains.py
* plugins/display/top_downloads_diff.py * plugins/display/top_downloads_diff.py
* plugins/display/top_downloads.py * plugins/display/top_downloads.py
* plugins/display/top_hits.py * plugins/display/top_hits.py
@ -133,9 +135,11 @@ Optional configuration values ends with *.
* plugins/post_analysis/filter_users.py * plugins/post_analysis/filter_users.py
* plugins/post_analysis/hours_stats.py * plugins/post_analysis/hours_stats.py
* plugins/post_analysis/ip_to_geo.py * plugins/post_analysis/ip_to_geo.py
* plugins/post_analysis/ip_type.py
* plugins/post_analysis/operating_systems.py * plugins/post_analysis/operating_systems.py
* plugins/post_analysis/referers.py * plugins/post_analysis/referers.py
* plugins/post_analysis/reverse_dns.py * plugins/post_analysis/reverse_dns.py
* plugins/post_analysis/subdomains.py
* plugins/post_analysis/top_downloads.py * plugins/post_analysis/top_downloads.py
* plugins/post_analysis/top_hits.py * plugins/post_analysis/top_hits.py
* plugins/post_analysis/top_pages.py * plugins/post_analysis/top_pages.py
@ -423,6 +427,32 @@ plugins.display.ip_to_geo
None None
plugins.display.ip_type
-----------------------
Display hook
Add IPv4/IPv6 statistics
Plugin requirements :
post_analysis/ip_type
Conf values needed :
None
Output files :
OUTPUT_ROOT/year/month/index.html
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.istats_diff plugins.display.istats_diff
--------------------------- ---------------------------
@ -560,6 +590,32 @@ plugins.display.robot_bandwidth
None None
plugins.display.subdomains
--------------------------
Display hook
Add subdomains statistics
Plugin requirements :
post_analysis/subdomains
Conf values needed :
None
Output files :
OUTPUT_ROOT/year/month/index.html
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.top_downloads_diff plugins.display.top_downloads_diff
---------------------------------- ----------------------------------
@ -790,12 +846,15 @@ plugins.post_analysis.feeds
If merge_feeds_parsers is set to True, 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. as it must be the same person with a different IP address.
Warning : When merge_feeds_parsers is activated, last access display date is the more
recent date of all merged parsers found
Plugin requirements : Plugin requirements :
None None
Conf values needed : Conf values needed :
feeds feeds
feeds_referers* feeds_agents*
merge_feeds_parsers* merge_feeds_parsers*
Output files : Output files :
@ -805,6 +864,7 @@ plugins.post_analysis.feeds
remote_addr => remote_addr =>
feed_parser feed_parser
feed_name_analysed feed_name_analysed
feed_parser_last_access (for merged parser)
Statistics update : Statistics update :
None None
@ -936,6 +996,37 @@ plugins.post_analysis.ip_to_geo
None None
plugins.post_analysis.ip_type
-----------------------------
Post analysis hook
Detect if IP is IPv4 or IPv6
Plugin requirements :
None
Conf values needed :
None
Output files :
None
Statistics creation :
visits :
remote_addr =>
ip_type
month_stats :
ip_type : {4: XXX, 6: XXX}
Statistics update :
None
Statistics deletion :
None
plugins.post_analysis.operating_systems plugins.post_analysis.operating_systems
--------------------------------------- ---------------------------------------
@ -1037,6 +1128,34 @@ plugins.post_analysis.reverse_dns
None None
plugins.post_analysis.subdomains
--------------------------------
Post analysis hook
Group top pages by subdomains
Plugin requirements :
post_analysis/top_pages
Conf values needed :
None
Output files :
None
Statistics creation :
month_stats:
subdomains =>
domain => count
Statistics update :
None
Statistics deletion :
None
plugins.post_analysis.top_downloads plugins.post_analysis.top_downloads
----------------------------------- -----------------------------------

View File

@ -6,11 +6,13 @@
* plugins/display/filter_users.py * plugins/display/filter_users.py
* plugins/display/hours_stats.py * plugins/display/hours_stats.py
* plugins/display/ip_to_geo.py * plugins/display/ip_to_geo.py
* plugins/display/ip_type.py
* plugins/display/istats_diff.py * plugins/display/istats_diff.py
* plugins/display/operating_systems.py * plugins/display/operating_systems.py
* plugins/display/referers_diff.py * plugins/display/referers_diff.py
* plugins/display/referers.py * plugins/display/referers.py
* plugins/display/robot_bandwidth.py * plugins/display/robot_bandwidth.py
* plugins/display/subdomains.py
* plugins/display/top_downloads_diff.py * plugins/display/top_downloads_diff.py
* plugins/display/top_downloads.py * plugins/display/top_downloads.py
* plugins/display/top_hits.py * plugins/display/top_hits.py
@ -23,9 +25,11 @@
* plugins/post_analysis/filter_users.py * plugins/post_analysis/filter_users.py
* plugins/post_analysis/hours_stats.py * plugins/post_analysis/hours_stats.py
* plugins/post_analysis/ip_to_geo.py * plugins/post_analysis/ip_to_geo.py
* plugins/post_analysis/ip_type.py
* plugins/post_analysis/operating_systems.py * plugins/post_analysis/operating_systems.py
* plugins/post_analysis/referers.py * plugins/post_analysis/referers.py
* plugins/post_analysis/reverse_dns.py * plugins/post_analysis/reverse_dns.py
* plugins/post_analysis/subdomains.py
* plugins/post_analysis/top_downloads.py * plugins/post_analysis/top_downloads.py
* plugins/post_analysis/top_hits.py * plugins/post_analysis/top_hits.py
* plugins/post_analysis/top_pages.py * plugins/post_analysis/top_pages.py
@ -313,6 +317,32 @@ plugins.display.ip_to_geo
None None
plugins.display.ip_type
-----------------------
Display hook
Add IPv4/IPv6 statistics
Plugin requirements :
post_analysis/ip_type
Conf values needed :
None
Output files :
OUTPUT_ROOT/year/month/index.html
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.istats_diff plugins.display.istats_diff
--------------------------- ---------------------------
@ -450,6 +480,32 @@ plugins.display.robot_bandwidth
None None
plugins.display.subdomains
--------------------------
Display hook
Add subdomains statistics
Plugin requirements :
post_analysis/subdomains
Conf values needed :
None
Output files :
OUTPUT_ROOT/year/month/index.html
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.top_downloads_diff plugins.display.top_downloads_diff
---------------------------------- ----------------------------------
@ -680,12 +736,15 @@ plugins.post_analysis.feeds
If merge_feeds_parsers is set to True, 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. as it must be the same person with a different IP address.
Warning : When merge_feeds_parsers is activated, last access display date is the more
recent date of all merged parsers found
Plugin requirements : Plugin requirements :
None None
Conf values needed : Conf values needed :
feeds feeds
feeds_referers* feeds_agents*
merge_feeds_parsers* merge_feeds_parsers*
Output files : Output files :
@ -695,6 +754,7 @@ plugins.post_analysis.feeds
remote_addr => remote_addr =>
feed_parser feed_parser
feed_name_analysed feed_name_analysed
feed_parser_last_access (for merged parser)
Statistics update : Statistics update :
None None
@ -826,6 +886,37 @@ plugins.post_analysis.ip_to_geo
None None
plugins.post_analysis.ip_type
-----------------------------
Post analysis hook
Detect if IP is IPv4 or IPv6
Plugin requirements :
None
Conf values needed :
None
Output files :
None
Statistics creation :
visits :
remote_addr =>
ip_type
month_stats :
ip_type : {4: XXX, 6: XXX}
Statistics update :
None
Statistics deletion :
None
plugins.post_analysis.operating_systems plugins.post_analysis.operating_systems
--------------------------------------- ---------------------------------------
@ -927,6 +1018,34 @@ plugins.post_analysis.reverse_dns
None None
plugins.post_analysis.subdomains
--------------------------------
Post analysis hook
Group top pages by subdomains
Plugin requirements :
post_analysis/top_pages
Conf values needed :
None
Output files :
None
Statistics creation :
month_stats:
subdomains =>
domain => count
Statistics update :
None
Statistics deletion :
None
plugins.post_analysis.top_downloads plugins.post_analysis.top_downloads
----------------------------------- -----------------------------------