From 43e5e97c5a810db3cd06e000be1732f52f1d58bf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gr=C3=A9gory=20Soutad=C3=A9?= <gsoutade@neotion.com>
Date: Mon, 8 Dec 2014 18:38:40 +0100
Subject: [PATCH] Add some comments

---
 conf.py         | 23 +++++++++--------------
 default_conf.py | 18 +++++++++++++++++-
 2 files changed, 26 insertions(+), 15 deletions(-)

diff --git a/conf.py b/conf.py
index da31821..d3c7dfc 100644
--- a/conf.py
+++ b/conf.py
@@ -1,27 +1,22 @@
 
-log_format = '$server_name:$server_port $remote_addr - $remote_user [$time_local] ' +\
-             '"$request" $status $body_bytes_sent ' +\
-             '"$http_referer" "$http_user_agent"';
-
-#09/Nov/2014:06:35:16 +0100
-time_format = '%d/%b/%Y:%H:%M:%S +0100'
-
+# Web server log
 analyzed_filename = 'access.log'
 
+# Domain name to analyze
 domain_name = 'soutade.fr'
 
+# Display visitor IP in addition to resolved names
 display_visitor_ip = True
 
-DB_ROOT = './output/'
-DISPLAY_ROOT = './output/'
-
+# Hooks used
 pre_analysis_hooks = ['page_to_hit', 'robots']
 post_analysis_hooks = ['referers', 'top_pages', 'top_downloads', 'top_hits']
-# post_analysis_hooks = ['top_visitors', 'reverse_dns']
 display_hooks = ['top_visitors', 'all_visits', 'referers', 'top_pages', 'top_downloads', 'top_hits']
 
+# Reverse DNS timeout
 reverse_dns_timeout = 0.2
-page_to_hit_conf = [r'^.+/logo[/]?$']
-hit_to_page_conf = [r'^.+/category/.+$', r'^.+/tag/.+$', r'^.+/archive/.+$', r'^.+/ljdc[/]?$']
 
-count_hit_only_visitors = True
+# Count this addresses as hit
+page_to_hit_conf = [r'^.+/logo[/]?$']
+# Count this addresses as page
+hit_to_page_conf = [r'^.+/category/.+$', r'^.+/tag/.+$', r'^.+/archive/.+$', r'^.+/ljdc[/]?$']
diff --git a/default_conf.py b/default_conf.py
index d9b445e..18cc103 100644
--- a/default_conf.py
+++ b/default_conf.py
@@ -2,34 +2,50 @@ import os
 
 # Default configuration
 
+# Default directory where to store database information
 DB_ROOT = './output'
+# Default directory where to create html files
 DISPLAY_ROOT = './output'
-HOOKS_ROOT = 'plugins'
 
+# Hooks directories (don't edit)
+HOOKS_ROOT = 'plugins'
 PRE_HOOK_DIRECTORY = HOOKS_ROOT + '.pre_analysis'
 POST_HOOK_DIRECTORY = HOOKS_ROOT + '.post_analysis'
 DISPLAY_HOOK_DIRECTORY = HOOKS_ROOT + '.display'
+# Meta Database filename
 META_PATH = os.path.join(DB_ROOT, 'meta.db')
+# Database filename per month
 DB_FILENAME = 'iwla.db'
 
+# Web server log format (nginx style). Default is what apache log
 log_format = '$server_name:$server_port $remote_addr - $remote_user [$time_local] ' +\
     '"$request" $status $body_bytes_sent ' +\
     '"$http_referer" "$http_user_agent"'
 
+# Time format used in log format
+# TOFIX UTC
 time_format = '%d/%b/%Y:%H:%M:%S +0100'
 
+# Hooks that are loaded at runtime (only set names without path and extensions)
 pre_analysis_hooks = []
 post_analysis_hooks = []
 display_hooks = []
 
+# Extensions that are considered as a HTML page (or result)
 pages_extensions = ['/', 'htm', 'html', 'xhtml', 'py', 'pl', 'rb', 'php']
+# HTTP codes that are cosidered OK
 viewed_http_codes = [200, 304]
 
+# If False, doesn't cout visitors that doesn't GET a page but resources only (images, rss...)
 count_hit_only_visitors = True
 
+# Multimedia extensions (not accounted as downloaded files)
 multimedia_files = ['png', 'jpg', 'jpeg', 'gif', 'ico',
                     'css', 'js']
 
+# Default resources path (will be symlinked in DISPLAY_OUTPUT)
 resources_path = ['resources']
+# Icon path
 icon_path = '%s/%s' % (os.path.basename(resources_path[0]), 'icon')
+# CSS path (you can add yours)
 css_path = ['%s/%s/%s' % (os.path.basename(resources_path[0]), 'css', 'iwla.css')]