			Bugzero/ActiveLog README


Thank you for using Bugzero/ActiveLog! We hope you find it useful.

-----------
Requirement
-----------

  1. Java SDK 1.3 or later. If you do not have Java SDK installed, please
     go to http://java.sun.com/j2se/downloads.html to download it. Make sure that
     you download the Standard Development Kit (SDK), instead of the Java Runtime 
     Environment (JRE). After installation, you need add the java bin folder 
     (such as c:\jdk1.3.1_04\bin) in the system path and add an environment
     variable JAVA_HOME pointing to the pathname where Java is installed
     (such as c:\jdk1.3.1_04). 

  2. A Java Servlet (or J2EE) server. If you do not have one, you can 
     download the latest standard full binary Tomcat 4.1 (a zip, exe, or tar file)
     from apache.org (http://jakarta.apache.org/builds/jakarta-tomcat-4.0/release/).
     After installation, you can launch Tomcat by typing 'catalina run' in its
     bin directory. On Windows, a Tomcat service might be installed during
     the installation process. In such a case, you can also use this service
     to start tomcat. You should launch a browser and type in the url 
     'http://localhost:8080/' to test whether it worked or not.

  3. A database. You should create a database user account and probably an empty
     database for Bugzero/ActiveLog. For jdbc driver related issues, see faq.txt. 

  4. (Optional) An outgoing SMTP mail account for sending email notification.
     You need create a mail account for Bugzero/ActiveLog.


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

  1. unzip bugzero.zip and extract the entire bugzero directory to your
     servlet engine's applications directory. If you do not know where is
     this directory, extract bugzero into a temp directory. 

  2. Under directory ../bugzero/WEB-INF, run 'setup'.

     This setup program will guide you through all the system configurations
     including the database, the email account, and the servlet engine.
     It will also instruct you where to deploy Bugzero.

     Note that, on Unix/Linux OS, you may need do 'chmod +x setup.sh' to make it
     executable. You may also need type ./setup.sh instead of just setup.sh.

-------------------
Manual Installation
-------------------
  
  If your environment does not have the graphics support to run the setup program,
  you can configure the system with the following manual steps:

  1. Database server properties

     Modify the file, bugzero/WEB-INF/classes/conf/db.properties
     a) set the database name, bugzero.database=databaseX
        here databaseX can be one of
        access, mssql, mysql, oracle, db2, postgresql, sybase, and pointbase. 
     b) set the url, user, password of the corresponding databaseX.

  2. JDBC driver

     For databases Access and MySQL, the JDBC driver is already provided and nothing
     need to do done. If you are using Oracle, SQL Server, DB2, etc, you need add
     the corresponding JDBC driver into the lib directory (bugzero/WEB-INF/lib).


  3. Mail server properties

     Modify the file, bugzero/WEB-INF/classes/conf/mail.properties
        mail.smtp.host=
        mail.smtp.from=
        mail.username=
        mail.password=

  4. Create base tables (command-line)

     Under directory ../bugzero/WEB-INF/bin, first run 

     'database -test' to test the database connection. If it connects, then run

     'database -admin whateverPassword' to create all the base tables as well as 

     the administration account. The administration account is required for 
     managing the project and user accounts through the web interface.

     (Optional) To create the demo project, run 'database -create demo'.
     This will create the demo tables based on the project/demo_* files (included). 

     Note that, on Unix/Linux OS, you may need do 'chmod +x database.sh' to make it
     executable. You may also need type ./database.sh instead of just database.sh.

  5. Deploy to Servlet engine:

     Bugzero is deployed on a Servlet engine, you must

     a. Move the entire bugzero directory to your servlet engine's application
        directory. Possible locations of this directory are:
          Tomcat - .../webapps/
          WebLogic - .../config/mydomain/applications/

     b. After you dropped bugzero to the applications directory, Bugzero could
        be deployed automatically (depending on the server and configuration).

     c. For some servers such as WebSphere, you may need make a bugzero.war file
        from the bugzero directory and deploy this war file instead.
        To make the war file, go inside the bugzero directory and type (without '')
        'jar cvfM ../bugzero.war .', the resulted bugzero.war is in the same 
        directory where bugzero is located.

     For more details, consult the corresponding file under WEB-INF/classes/install.


--------------------
Start Servlet Engine
--------------------
  You should already have

  1. installed and configured Bugzero.
  2. moved the bugzero directory to the servlet engine's applications directory.

  You can now start (restart) the servlet engine. Please launch a browser,
  and go to the url  http://localhost:port/bugzero/
  you should see the welcome page. (replace port with the actual port number of
  your servlet engine, and localhost of the proper url)

  How to start your servlet engine with command-line (just an example):

    Tomcat:     under bin dir, cataline run
    WebLogic:   under server/mydomain dir, startWeblogic
    WebSphere:  UI based
    Oracle9iAS: under j2ee/home/, java -jar oc4j.jar
    Orion:      under Orion, java -jar orion.jar
    Resin:      under bin dir, httpd


---------
Self Help
---------
  If you encounter a problem, there are two places you should look at first.
  One is the bugzero/WEB-INF/classes/log/bugzero.log file which records the runtime
  information. The other one is faq.txt which may have already listed your problem
  and had a solution.

---------
Questions
---------
Bugzero homepage: http://www.websina.com/bugzero/
If you have any questions, mailto: dev@websina.com
