1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
#######################################################################
# $Id: INSTALL 470 2007-11-07 09:58:04Z steve $
# Copyright (C) 2005, 2006 by Stephen McInerney (spm@stedee.id.au)
#######################################################################
Installation instructions for AWFFull
Requirements:
-------------
AWFFull is dependant on several external libraries, most should be on a
standard *nix system anyway, some are more specific.
The main additional libraries being:
* PNG for creating the various images
http://www.libpng.org/pub/png/
* GD for creating the graphs as png images
http://www.boutell.com/gd/
* ZLIB for reading compressed log files
http://www.gzip.org/zlib/
* PCRE for simplifying the matching of log entries
http://www.pcre.org/
If you require more accurate Country tracking, you can make use of GeoIP.
http://www.maxmind.com/app/geoip_country
* To get TrueType Fonts working, you will need some truetype fonts. I'd
suggest the urw-fonts package as a starting point.
Basic Installation:
-------------------
* Untar the source file
* cd into the newly created source directory
* ./configure
* make
* make install
Eg:
$ tar zxf awffull-3.7.1.tar.gz
$ cd awffull-3.7.1
$ ./configure
$ make
$ make install
The "make install" may need to be performed as a privileged user (root).
Basic Usage and Running of AWFFull:
-----------------------------------
AWFFull comes with two sample configuration files:
sample.minimal.conf - being an absolute minimal config to get started
sample.conf - being the all configuration options, with explanations.
You don't require either to run AWFFull, but it is recommended to gradually
reconfigure the defaults to fine tune against your needs.
A normal run would be similar to:
awffull -c awffull.mywebsite.conf logfile.lastmonth.log.gz
AWFFull generates several HTML files and png images in a designated output
directory. Either open directly with a local web browser, or access via
a web server configured to allow access to that directory.
NB! AWFFull will attemp to load a default configuration file. So you may be
picking up configuration that you had not intended to.
Advanced Installation:
----------------------
Assumes that you are already familiar with GNU autobuilding.
Additional configure options are:
--with-gd=DIR Where to additionally look for gd header files
--with-gdlib=DIR Alternate location for libgd library
--with-z=DIR Alternate location for libz header files
--with-zlib=DIR Alternate location for libz library
--with-png=DIR Alternate location of png header files
--with-pnglib=DIR Alternate location for libpng library
--with-geoip=DIR Alternate location of geoip header files
--with-geoiplib=DIR Alternate location for libGeoIP library
--with-font-default=FILE
Where to look for the Default TrueType Font
--with-font-label=FILE Where to look for the Default Label TrueType Font
--disable-geoip Disable GeoIP (default=no)
--disable-ttf Disable TrueType Fonts (default=no)
These all assist with locating libraries and headers in non standard
locations.
"--with-font-default" will override the otherwise hardcoded TrueType
Font to use. See src/graph.h
"--with-font-label" is similar to --with-font-default, but changes the
font used for labels.
"--disable-geoip" will stop automatic inclusion of GeoIP
capabilities if otherwise found.
"--disable-ttf" will stop the automatic inclusion of the GD Truetype
Font libraries, if otherwise found.
The default font family that AWFFull will attempt to use is 'Helvetica'. See
your fontconfig (/etc/fonts/...) for more detail.
Graphs With No Text!
--------------------
Please do be aware that the above strongly imples that you have a working
fontconfig setup on your machine. You'll get graphs with no text otherwise.
A quick check with "ldd" can easily verify this one. See:
http://www.stedee.id.au/pipermail/awffull/2007-November/000581.html
for a long winded look at trying to resolve this.
You can also use the afore mentioned --with-font-* overrides to force a
particular file to be loaded instead.
--enable-debug Turn on compiler debugging information (default=no)
--enable-developer Turn on developer warnings and debugging
(default=no)
These two enable additional levels of error checking in the compiled code.
Developer mode additionally adds a lot more compile time warnings and
enables profiling mode for use with gprof. This *really* slows down
normal run speeds, and is recommended only for those keen to help
with coding/debugging/performance issues.
Country Flags:
--------------
With version 3.7.1 of AWFFull, a set of country flags from
http://flags.blogpotato.de/ can be included and displayed in the country
table.
These are all stored in the "flags" subdirectory, and need to be manually
copied to a web server or similar for access.
The location can be specified within the config file, and can be a complete
URL, vs relative position from a web root. Thus multiple awffull reports
could access a single set of flag picture files.
See 'FlagsLocation' for more details. By default the flags will not display.
GeoIP:
------
With version 3.7.1 of AWFFull, the GeoIP API can be called.
By default, if they exist on the system where AWFFull is being
built, then the resulting binary will enable access to GeoIP.
Do be aware that the default state of AWFFull is to *NOT* actually use
GeoIP. Mainly to maintain existing backwards compatibility.
This can be controlled at both build time (configure --disable-geoip) and
at run time (awffull --use_geoip).
|