
---------------------------------------------------------------------------
Traffic Squeezer - Readme
Version : 0.15.7
Author  : Kiran K(Sathya Ravi Kiran Kumar Raja. K) 2006-2008
Email   : kiran_cyberpro at yahoo dot com
Release : 19_Apr_2008
---------------------------------------------------------------------------


LICENSE:

Traffic Squeezer is free software; you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.

Traffic Squeezer is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Zebra; see the file COPYING.  If not, write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.



INTRODUCTION:

Traffic Squeezer is an open-source project which does WAN Network 
Traffic-Acceleration  on a Linux based network device. Traffic Squeezer 
uses a set of methods to achieve traffic acceleration. Refer the 
project website documentation page for more details.

DATA COMPRESSION:
One of the acceleration methods is traffic payload compression.
To do the same Traffic Squeezer uses the Open-Source
Basic Compression Library
	URL: http://bcl.sourceforge.net
	Author(s): Marcus Geelnard (marcus.geelnard at home.se)

with some minor modifications so that the existing algorithms have been
exposed in a form of APIs so that the same is called whenever there is a
network-payload chunk have to be compressed.

WEB-INTERFACE:
Traffic Squeezer provides the web-interface, for which the Traffic Squeezer 
uses the
SWILL Open Source Library V0.2:
	URL: http://swill.sourceforge.net 
	Author(s):  David Beazley (dave@dabeaz.com)
        	    Sotiria Lampoudi (slampoud@cs.uchicago.edu)
	            Gonzalo Diethelm (gonzo@diethelm.org)  

which is quite modified to suit Traffic Squeezer requirements made a  
part of Traffic Squeezer code itself (trafficsqueezer-swill-1.0), and hence
the users need not once again download SWILL seperately and compile the same
before compiling Traffic Squeezer. Or in other words the Traffic Squeezer 
code automatically compiles the modified SWILL Library before itself gets
compiled.

* Refer project Documentation for more details.



USAGE:

1. Un-tar the contents into a folder.
   #tar -xzvf trafficsqueezer.<version>.tar.gz
   
2. Move in to the directory contains code.

3. Compile Traffic Squeezer code.
    #make


4. Installing Traffic Squeeser:
To install the traffic squeezer first the code has to be compiled then the
binaries and the  configuration files can be stored in the relevant places.
The make install hander script does the both. Finally after executing this
command the trafficsqueezer binary will gets stored under /sbin folder. And
the default configuration file which exists in the config folder of the 
source-code folder will get copied under /etc/trafficsqueezer/trafficsqueezer.cfg.

    Here is a sample trafficsqueezer.cfg contents:
       #Traffic Squeezer Configuration File
          ingress_port = eth0
          egress_port  = eth1


    And the Traffic Squeezer web interface resource files are copied into the
    /usr/share/trafficsqueezer folder.

    #make install


5. Execute Traffic Squeezer binary. Here is its usage syntax:
    #trafficsqueezer [-i <ingress port> -e <egress port>] [-f <configuration file>]


6: To view/configure the Traffic Squeezer Web-Interface access its home folder
through typing the following URL in the browser:
    http://<ip-address>:8080/intro.html


BUGS:

To report the bugs in the Traffic Squeezer project please contact the
project bugzilla link or post the issues in the project open-discussion
forum.



FAQs:

The project FAQS are listed under the Traffic Squeezer project documentation
page's FAQS tab.



NOTE:

1. Verify the Traffic Squeezer ChangeLog file to find the details about
   the current version and to track changes done w.r.t each release.

2. For any enquiries, suggestions, comments or ideas please contact the 
   project discussion forum.

3. The "dontuse" versions are meant to look for the code design or its
   architectural details. The "dontuse" version release code might
   be unstable and can contain known and unknown bugs.
 
---------------------------------------------------------------------------




