"Fossies" - the Fresh Open Source Software Archive 
As a special service "Fossies" has tried to format the requested text file into HTML format (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
1 ===============================================================================
2
3 README FILE FOR SQUID-GRAPH
4
5 To find out more, visit the website at:
6 http://squid-graph.sourceforge.net/
7
8 ===============================================================================
9
10 NOTE: AS OF VERSION 3, THE OFFICIAL DOCUMENTATION IS IN HTML FORMAT. THIS
11 README FILE IS PROVIDED FOR THE CONVINIENCE OF USERS WHO DO NOT HAVE
12 HTML VIEWERS.
13
14
15 WHAT IS SQUID-GRAPH?
16 =====================
17
18 Squid-Graph is a free, simple, but powerful Squid logfile analysis tool
19 distributed under the GNU General Public Licence. It generates reports which
20 analyzes the traffic of a Squid proxy server in the form of graphs.
21
22
23
24 SUPPORTED PLATFORMS
25 ====================
26
27 Squid-Graph is actively developed on a Linux machine running Perl 5 and
28 2.2.x to 2.4.x kernel. It should work with most other similar operating
29 systems.
30
31 A few platforms which Squid-Graph have been reported to work with are
32 FreeBSD, OpenBSD, Sun Solaris and various different Linux distributions.
33
34 To use in Windows, you can obtain the Win32 port of PERL from ActiveState,
35 and modify the code of this software, but we will not provide support for
36 Windows-specific issues because we did not design this program to work with
37 Windows.
38
39
40
41 PRE-REQUISITES
42 ===============
43
44 You will need a working copy of PERL 5 and GD-1.3.3 installed.
45 See http://search.cpan.org/dist/GD/ for latest GD version.
46
47 GD _MUST_ be working, i.e. all its dependent libs must also be installed for
48 Squid Graph v3 to work.
49
50 ... and of course, you'll need a Squid proxy server.
51
52
53
54 INSTALLING SQUID-GRAPH
55 =======================
56
57 Extract the tarball file squid-graph-x.x.tar.gz into a desired directory. To
58 extract,
59
60 Linux:
61 $ tar -zxvf squid-graph-x.x.tar.gz
62
63 Other UNIX:
64 $ zcat squid-graph-x.x.tar.gz | tar xvf -
65
66
67 Then, move the extracted contents to your desired directory. e.g.
68
69 $ mv squid-graph-x.x /usr/local/squid-graph
70
71
72
73 CONFIGURING SQUID-GRAPH
74 ========================
75
76 As of version 3.0, there aren't any more configuration files. For a list
77 of configuration options, simply run squid-graph without any parameters.
78
79 $ cd bin
80 $ ./squid-graph
81
82
83 FOR EXPERTS ONLY:
84
85 For experts, you might want to configure some things like your graph colours
86 or remove the console output messages. This can be done by editing the file
87 `squid-graph', and then changing the $MYCONSOLELOG variable and the $color
88 variables to your preferred values.
89
90 $ vi squid-graph
91
92
93 RUNNING SQUID-GRAPH
94 ====================
95
96 Quickstart:
97 To run Squid Graph with the default settings, simply do this:
98
99 $ cd bin
100 $ ./squid-graph --output-dir=/tmp < /usr/local/squid/access.log
101
102
103 However, you really won't want the reports to end up in /tmp, so you might
104 want to specify another directory, for example: -
105
106 $ ./squid-graph --output-dir=/var/www/html < /usr/local/squid...
107
108
109 If you hate the annoying console ouput/logging, you can disable it
110 by using the --no-console-log parameter, e.g.
111
112 $ ./squid-graph --no-console-log --output-dir=/var/www/html...
113
114
115 Advanced:
116 If your cache only logs TCP or does not use the UDP at all, you can
117 specify the --tcp-only option for tcp-only output. e.g.
118
119 $ ./squid-graph --tcp-only --output-dir=/var/www/html...
120
121
122 Likewise, if you would like to see only UDP reports, you can specify
123 the --udp-only option. e.g.
124
125 $ ./squid-graph --udp-only --output-dir=/var/www/html...
126
127
128 For more help on running Squid Graph, see the HTML documentation or
129 the project website.
130
131
132
133 RUNNING SQUID-GRAPH IN REAL TIME VIA THE WEB
134 =============================================
135
136 As of v3, Squid Graph does not support this feature anymore. If you would
137 still like to do this, simply create a shell script to execute Squid
138 Graph.
139
140 We do not recommend this unless your log files are really small. Also,
141 we did not audit Squid Graph for any possible security issues that might
142 arise in an online CGI enviroment. YOU HAVE BEEN WARNED.
143
144
145
146 ACKNOWLEDGEMENTS
147 =================
148
149 GD.pm interface, copyright 1995-2000, Lincoln D. Stein.
150 http://search.cpan.org/dist/GD/
151
152
153
154 CONTRIBUTIONS/CONTACTING US
155 ============================
156
157 To contribute, please visit our Sourceforge project page at:
158 http://sourceforge.net/projects/squid-graph/
159
160
161
162 GNU GPL
163 ========
164
165 Included with the distribution should be the licence in plain text format
166 as gpl.txt.
167