README*, config: Removed the version number from these files.
[yaala.git] / config
1 ########################################################################
2 #    yaala config                                                      #
3 #---==============-----------------------------------------------------#
4 # http://yaala.org/                                                    #
5 # For exact instructions please see the README and the notes above     #
6 # each entry.                                                          #
7 ########################################################################
8
9 # Tells yaala the directory to save the html pages in.
10 # You should manually copy .gif and .css there from html
11 # directory.
12 # Default is 'reports'
13 #directory: 'reports';
14
15 # Here you can choose between the ``new'' Combined-output module and the
16 # Classic-output which emulates 0.4.x behaviour.
17 # Default is to use 'Combined'
18 #report: 'Combined';
19
20 # The module used for parsing the logfile(s)
21 # The modules coming with this package are:
22 # - Bind9
23 # - Common
24 # - Ncsa
25 # - Wnserver
26 # - Squid
27 # - Xferlog
28 # - Postfix
29 # Default: 'Common'
30 #logtype: 'Common';
31
32
33 #########################################################################
34 #    Output                                                             #
35 #---========------------------------------------------------------------#
36 # The directive 'select' selects data to be printed in the report.      #
37 # For an explaination please read ``README.selections''                 #
38 #########################################################################
39
40 #select: "aggregation BY field, field, field WHERE field == value";
41
42
43 ########################################################################
44 #    Filtering                                                         #
45 #---===========--------------------------------------------------------#
46 # These options adjust filtering data which appear in reports.         #
47 ########################################################################
48
49 # Wether or not yaala shall try to lookup domain names of ip adresses.
50 # Set to 'true' or 'false'. Default is not to.
51 #reverse_lookup: 'true';
52
53 # Sets how many subdomains of a host should be displayed. "1" means only
54 # the domain (plus the top-level domain), e.g. "example.com", "2" would
55 # be ``subdomain.example.com''. Set zero to get the full length of a
56 # hostname. This option also controls wether unresolved IP adresses are
57 # displayed as ``192.0.0.0/8'' (host_width = 1), ``192.168.0.0/16''
58 # (host_width = 2), etc.
59 # Defaults to "1"
60 #host_width: 1;
61
62 # With the classic output module not all combinations of fields appear in
63 # the log and are therefore empty. These empty cells are normally skipped.
64 # If you, for whatever reason, what these cells to be printed, set the
65 # following option to 'false'.
66 #classic_skip_empty: true;
67
68
69 ########################################################################
70 #    HTML                                                              #
71 #---======-------------------------------------------------------------#
72 # These options affect html files generation, mostly - the HEAD        #
73 # section.                                                             #
74 ########################################################################
75
76 # If u're going to browse html pages from FILES
77 # rather then via http AND on OS with another
78 # default charset, specify charset of your html
79 # pages to put into META http-equiv tag.
80 # With webserver, proper charset SHOULD be passed 
81 # in http header by server.
82 # Default is 'iso-8859-1'.
83 #html_charset: iso-8859-1;
84
85 # URL to css file with style definition for
86 # report pages. Goes linked it from html head.
87 # You may put here an url or path to other css file,
88 # (maybe - site-wide or reports-wide)
89 # default is 'style.css' (should be copied where reports lie)
90 #html_stylesheet: '/default.css';
91 #html_stylesheet: '/yaala-reports/style.css';
92 html_stylesheet: 'style.css';
93
94
95 ########################################################################
96 #    Graphs                                                            #
97 #---========-----------------------------------------------------------#
98 # These options affect the generation of graphs and their size. If     #
99 # unsure leave this untouched. The defaults are set to reasonable      #
100 # values.                                                              #
101 ########################################################################
102
103 # Sets wether or not graphs will be generated. Defaults to generate
104 # graphs if GD::Graph is installed and don't, if it is not.
105 #print-graphs: 'true';
106
107 # The following two options control the size of the graphs generated.
108 # Values are pixels.
109 #graph_height: 250;
110 #graph_width: 500;
111
112
113 ########################################################################
114 #    Persistency                                                       #
115 #---=============------------------------------------------------------#
116 # These options determine if persistency is used and which file the    #
117 # data is stored in. If unsure don't touch.                            #
118 ########################################################################
119
120 # Sets wether or not persistency should be used. For this to work you
121 # need to have the ``Storable'' module installed. If unset the module
122 # will look for ``Storable'' and if it can find it will use persistency.
123 #use_persistency: 'true';
124
125 # Sets the file used to store the persistency data in. If you use a
126 # relative filename please keep in mind that it is relative to yaala's
127 # directory. Defaults to ``persistency.data''.
128 #persistency_file: 'persistency.data';
129
130 # vim: set tw=72 :