head	1.4;
access;
symbols
	TIGRIS_1_1_0RC2:1.3
	TIGRIS_1_1_0RC1:1.3
	EB_WM:1.4
	TIGRIS_1_1:1.3.0.6
	TIGRIS_1_0_8:1.3
	TIGRIS_1_0_8RC3:1.3
	TIGRIS_1_0_8RC2:1.3
	TIGRIS_1_0_8RC1:1.3
	TIGRIS_1_0_7:1.3
	TIGRIS_1_0_7RC3:1.3
	TIGRIS_1_0_7RC2:1.3
	TIGRIS_1_0_7RC1:1.3
	TIGRIS_1_0_6:1.3
	TIGRIS_1_0_6RC5:1.3
	TIGRIS_1_0_6RC4:1.3
	TIGRIS_1_0_6RC3:1.3
	TIGRIS_1_0_6RC2:1.3
	TIGRIS_1_0_6RC1:1.3
	TIGRIS_1_0_5:1.3
	TIGRIS_1_0_5RC6:1.3
	TIGRIS_1_0_5RC5:1.3
	TIGRIS_1_0_5RC4:1.3
	TIGRIS_1_0_5RC3:1.3
	TIGRIS_1_0_5RC2:1.3
	TIGRIS_1_0_5RC1:1.3
	TIGRIS_1_0_4:1.3
	TIGRIS_1_0_3:1.3
	TIGRIS_1_0_2:1.3
	TIGRIS_1_0_1:1.3
	TIGRIS_1_0:1.3.0.8
	TIGRIS_1_0_0:1.3
	TIGRIS_1_0_0_RC1:1.3.0.4
	HELM_PEER_PORT_BRANCH:1.3.0.2
	TIGRIS_0_9_2_4:1.2
	TIGRIS_0_9_2_3:1.2
	TIGRIS_0_9_2:1.2.0.6
	TIGRIS_0_9_0:1.2.0.4
	TIGRIS_0_8_4:1.2.0.2
	EYEBROWSE_WM_0_89:1.2
	pre-joist:1.1;
locks; strict;
comment	@# @;


1.4
date	2001.05.16.01.33.24;	author jhunter;	state Exp;
branches;
next	1.3;

1.3
date	2001.01.23.02.17.34;	author ms;	state Exp;
branches;
next	1.2;

1.2
date	2000.10.02.18.40.44;	author ms;	state Exp;
branches;
next	1.1;

1.1
date	2000.09.08.01.36.53;	author ms;	state Exp;
branches;
next	;


desc
@@


1.4
log
@Formatted the docs to 80-column width as is standard for text files.
No content changes yet.

-jh-
@
text
@Installing EYEBROWSE
--------------------
Preface:

Eyebrowse is not plug and play yet, its a relativly involved install process,
but the application is worth it!  If you have any recommendations on how the
install process can be made easier please mail dev@@eyebrowse.tigris.org with
you suggestions.  Users are the people that shape open-source projects most,
so make your voice count!

------------------------------------------------------------------------------------------------------------
Prerequistes:

_________________________
Application Dependancies|
-------------------------
1. Apache and JServ (or other servlet-engine).    
2. Mysql database server (http://www.mysql.org/) version 3.22 or greater.
3. A Java2 compliant developement-kit.
Note: JavaMail does not run properly under Kaffe, so if you are using Kaffe, 
you'll want to switch to a more reliable JVM.  
__________________
Java Dependancies|
------------------
Download and install into your java class path the following packages: 

  * Webmacro Templating Engine
    (http://www.webmacro.org/)
  * The Java Mail framework
    (http://www.javasoft.com/products/javamail/)
  * The Java Activation framework
    (http://java.sun.com/beans/glasgow/jaf.html)
  * The MM MySQL drivers
    (http://www.worldserver.com/mm.mysql/)
  * The GNU regexp package
    (http://www.cacas.org/~wes/java/index.html)
  * The Sun 1.1 version of the collections package 
    (http://java.sun.com/beans/infobus/)
  * The Lucene text-search engine library
    (http://lucene.sourceforge.net)

__________________________
Installation Instructions |
--------------------------

Since installing eyebrowse is particular to the servlet engine you're using it
is difficult to generalize this step. I will point out the *general* steps
you'll need to take for every environment and the specific servlet engine
documentation will be in this directory also.

1.  First make sure your servlet engine works, with some sort of "hello,
world!" type servlet.

2.  Compile eyebrowse with a 'make' in the top-level dir of the distribution.
This will build eyebrowse.jar in eyebrowse/lib.

3.  Map eyebrowse.jar into your servlet engine.

4.  Test that the eyebrowse classes are able to be loaded, getting a WebMacro
error is a sign that it has been installed and needs the database to be setup
and configured, which is the next step.

____________________________________________
Installing database that eyebrowse will use |
--------------------------------------------
5.  (optional) create an account for the eyebrowse application.  

a. Create a mysql database for eyebrowse, and grant permissions on it
    to the eyebrowse user: 
    mysql> CREATE DATABASE eyebrowse;
    mysql> GRANT ALL on eyebrowse.* to eyebrowse@@localhost;
    mysql> FLUSH PRIVILEGES;

5b. Create the necessary mysql tables
    mysql eyebrowse < $EYEBROWSE_ROOT/src/sql/eyebrowse-create.sql

_______________________________________________________________________________
See the document USING_EYEBROWSE for instructions on how to set up and 
administer eyebrowse lists.  
@


1.3
log
@Refactored Servlet Engine specific documentation out of this file and took out
SANDBOX references to be less confusing.
@
text
@d4 7
a10 2
Eyebrowse is not plug and play yet, its a relativly involved install process, but the application is worth it!
If you have any recommendations on how the install process can be made easier please mail dev@@eyebrowse.tigris.org with you suggestions.  Users are the people that shape open-source projects most, so make your voice count!
d17 5
a21 5
	1. Apache and JServ (or other servlet-engine).    
	2. Mysql database server (http://www.mysql.org/) version 3.22 or greater.
	3. A Java2 compliant developement-kit.
		Note: JavaMail does not run properly under Kaffe, so if you are using Kaffe, 
		you'll want to switch to a more reliable JVM.  
d46 4
a49 3
Since installing eyebrowse is particular to the servlet engine you're using it is difficult
to generalize this step. I will point out the *general* steps you'll need to take for every
environment and the specific servlet engine documentation will be in this directory also.
d51 2
a52 1
1.  First make sure your servlet engine works, with some sort of "hello, world!" type servlet.
d54 2
a55 2
2.  Compile eyebrowse with a 'make' in the top-level dir of the distribution. This will
    build eyebrowse.jar in eyebrowse/lib.
d59 4
a62 2
4.  Test that the eyebrowse classes are able to be loaded, getting a WebMacro error is a sign 
    that it has been installed and needs the database to be setup and configured, which is the next step.
@


1.2
log
@Overhaul and largely a rewrite of the install process.
Submitted by:	Michael Salmon
Reviewed by:	dev@@eyebrowse list
@
text
@d41 3
a43 8
Compiling and Installing eyebrowse distribution |
-------------------------------------------------
1.  In the toplevel directory for eyebrowse run a 'make', this will compile
the eyebrowse.jar file in the eyebrowse/lib/ directory. 

2.  Run a 'make install' in the same directory which will try to figure out your setup and 
install eyebrowse.jar, the conf files and the templates to the correct places if possible.
If it cannot detect your setup it will report to you that you need to move some things by hand.
d45 10
d57 1
a57 1
3.  (optional) create an account for the eyebrowse application.  
d59 1
a59 1
3a. Create a mysql database for eyebrowse, and grant permissions on it
d65 1
a65 1
3b. Create the necessary mysql tables
a66 20
___________________
Configuring server |
-------------------
4a. The servlet engine needs to know about the eyebrowse servlets and the eyebrowse.jar file,
    to do this edit 60eyebrowse.zone.properties.in as the instructions in the file suggest.

4b. Then add an "Include /path/to/60eyebrowse.zone.properties.in" directive in your zone.properties file.
    Note: The file-name can be changed to anything you wish. Also you can simply run 
    "cat 60eyebrowse.zone.properties.in >> /path/to/zone.properties" which will concatenate it on the
    end of the zone.properties file.


5a. Make sure the eyebrowse-templates match where WebMacro.properties is configured
    to look for them .  Make sure this properties file is in your path.  

6.  Edit the eyebrowse.properties.in per the instructions inside the file file to reflect the name of the
    database and the name of the eyebrowse user.  Make sure that this properties file is in your path.


Then fire up Apache and your servlet engine and you should be ready to go.  
d68 1
@


1.1
log
@Moved meta-files from eyebrowe/ to eyebrowse/docs
@
text
@d3 18
d22 2
a23 3
Follow these steps to install eyebrowse on your system.  

1.  Download and install into your java class path the following packages: 
d37 12
a48 5
Note: JavaMail does not run properly under Kaffe, so if you are using Kaffe, 
you'll want to switch to a more reliable JVM.  

2.  Unpack the eyebrowse files, and load the eyebrowse classes into
your java class path.
d50 2
a53 4
3.  Set up a mysql server (http://www.mysql.org/), if you don't have
one already set up.  Note: Eyebrowse requires version 3.22 or later of
mysql.  

d62 5
d68 4
a71 1
4.  Set up Apache and JServ (or your favorite servlet engine)
a72 2
4a. Edit the servlet engine properties and map the servlets as
    described in $EYEBROWSE_ROOT/servlet.properties 
d74 2
a75 2
5.  Get WebMacro and install and configure it for use with your servlet
    engine (http://www.webmacro.org)
d77 2
a78 3
5a. Edit the WebMacro.properties file to look for templates in the
    $EYEBROWSE_ROOT/src/webmacro directory.  Make sure this properties file
    is in your path.  
a79 3
6.  Edit the eyebrowse.properties file to reflect the name of the
    database and the name of the eyebrowse user.  Make sure that this
    properties file is in your path.
d81 1
a81 2

Then fire up your servlet engine and you should be ready to go.  
a84 2


@

