Read Me

This program 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 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

Copyright (c) Savoir-faire Linux, Inc 2005-2006


Commercial support
------------------

iSAK is developped by Savoir-faire Linux, a consulting compagny located in
Montreal, Quebec, Canada. If you want commercial support, take a look at 
http://isak.gplindustries.com/english/.


Introduction
------------

iSAK, Internet Secure Access Kit, is a Web traffic management platform built
on free softwares. iSAK is completely Open Source, developed under GPL license
and based on the Squid proxy. Squid is a high-performance proxy caching server
for web clients, supporting FTP, gopher, and HTTP queries. A lot of Open Source
softwares are joined to Squid to add administration, analysis and control
features.


iSAK components
---------------

iSAK is more than one software that are integrated together to create a complete
framework to manage your web traffic. A brief description of each component is
given in this file but more information is available in each component directory.

- isakidentserver: This is an external ACL program for Squid. This component must
  be used with isakportal and a memcached server.
- isakje: This is all the java programs used by Squid. If you need to run isakje
  programs, the INSTALL file of the component you want to used will tell you how.
- isakportal: This is the active portal where your end-users get redirected when
  they are not authenticated. Squid is in charge of the redirection. This
  component must be used with isakidentserver and a memcached server.
- isakstats: Stuff needed to run reports.
- isakurldb: Stuff needed to manage isakurldb. You probably don't need this
  because a central urlDB is already hosted on iSAK website.


Installation
------------

The installation of iSAK depends on your needs and your network architecture
because iSAK can be distributed on many computers. Installation instructions
for each components are available in their respective INSTALL file.


Installation examples
---------------------

To help you to know which component you need for your iSAK installation, here
is some installation examples:

- If you do not want to configure each end-user station to use the proxy, you
  must run isak in transparent mode. If you want authentication in transparent
  mode, you must use the isakportal and the isakidentserver.

- If you want to use isak reports, you do not need isakportal or isakidentserver,
  you just need isakstats and isakje.


Contributing to iSAK
--------------------

Of course we love patches and contributions.

The project infrastructure (SVN, bugtracker, MLs) is maintained on: 
http://www.sourceforge.net/projects/isak

Do not hesitate to join us and post comments, suggestions, questions
and general feedback on the mailing lists.