home *** CD-ROM | disk | FTP | other *** search
/ Chip 2003 July / CMCD0703.ISO / Software / Freeware / Programare / bugzero / WEB-INF / README.txt < prev    next >
Encoding:
Text File  |  2003-05-03  |  6.1 KB  |  149 lines
  1.             Bugzero README
  2.  
  3.  
  4. Thank you for using Bugzero! We hope you find it useful.
  5.  
  6. -----------
  7. Requirement
  8. -----------
  9.  
  10.   1. Java SDK 1.3 or later. If you do not have Java SDK installed, please
  11.      go to http://java.sun.com/j2se/downloads.html to download it. Make sure that
  12.      you download the Standard Development Kit (SDK), instead of the Java Runtime 
  13.      Environment (JRE). After installation, you need add the java bin folder 
  14.      (such as c:\jdk1.3.1_04\bin) in the system path and add an environment
  15.      variable JAVA_HOME pointing to the pathname where Java is installed
  16.      (such as c:\jdk1.3.1_04). 
  17.  
  18.   2. A Java Servlet (or J2EE) server. If you do not have one, you can 
  19.      download the latest standard full binary Tomcat 4.1 (a zip, exe, or tar file)
  20.      from apache.org (http://jakarta.apache.org/builds/jakarta-tomcat-4.0/release/).
  21.      After installation, you can launch Tomcat by typing 'catalina run' in its
  22.      bin directory. On Windows, a Tomcat service might be installed during
  23.      the installation process. In such a case, you can also use this service
  24.      to start tomcat. You should launch a browser and type in the url 
  25.      'http://localhost:8080/' to test whether it worked or not.
  26.  
  27.   3. A database. You should create a database user account and probably
  28.      an empty database for Bugzero. For jdbc driver related issues, see faq.txt. 
  29.  
  30.   4. (Optional) An outgoing SMTP mail account for sending email notification.
  31.      You need create a mail account for Bugzero.
  32.  
  33.  
  34. ------------
  35. Installation
  36. ------------
  37.  
  38.   1. unzip bugzero.zip and extract the entire bugzero directory to your
  39.      servlet engine's applications directory. If you do not know where is
  40.      this directory, put bugzero in a temp directory. 
  41.   2. on unix OS, cd to the directory bugzero/WEB-INF/ and type 'chmod +x setup'
  42.      and 'chmod +x bin/bugzero' to make them executable.
  43.   3. run setup.cmd (or setup on unix),
  44.      this setup program will guide you through all the system configurations
  45.      related to the database, the email account, and the servlet engine.
  46.      It will also tell you where to deploy Bugzero.
  47.  
  48. -------------------
  49. Manual Installation
  50. -------------------
  51.   
  52.   If the setup program cannot be run because a graphic DISPLAY is not available,
  53.   you can configure the system with the following manual steps:
  54.  
  55.   1. Database server properties
  56.  
  57.      You need modify the file, bugzero/WEB-INF/classes/conf/db.properties
  58.      a) set the database name, bugzero.database=databaseX
  59.         here databaseX can be one of
  60.         access, mssql, mysql, oracle, db2, postgresql, sybase, and pointbase. 
  61.      b) set the url, user, password of the corresponding databaseX.
  62.  
  63.   2. JDBC driver
  64.  
  65.      For databases of Access and MySQL, JDBC driver is already provided and nothing
  66.      need to do done. If you are using Oracle, SQL Server, DB2, etc, you need add
  67.      the corresponding JDBC driver into the lib directory (bugzero/WEB-INF/lib).
  68.  
  69.  
  70.   3. Mail server properties
  71.  
  72.      You need modify the file, bugzero/WEB-INF/classes/conf/mail.properties
  73.         mail.smtp.host=
  74.         mail.smtp.from=
  75.         mail.username=
  76.         mail.password=
  77.      Also modify the file, bugzero/WEB-INF/classes/template/email_body by
  78.      replacing 'http://localhost:8080' with the real url where Bugzero is deployed.
  79.  
  80.   4. Create tables
  81.  
  82.      Under bugzero/WEB-INF/bin directory, first run 
  83.  
  84.      'bugzero -test' to test the database connection. If it connects, then run
  85.       -------------
  86.      'bugzero -admin whateverPassword' to create all the base tables as well as 
  87.      the administration account. The administration account is required for 
  88.      managing the project and user accounts through the web interface.
  89.  
  90.      (Optional) To create the demo project, run "bugzero -create demo".
  91.      This will create the demo tables based on the project/demo_* files (included). 
  92.  
  93.   5. Create your project
  94.  
  95.      To manually create a project projectx, you must first have all the project
  96.      files in place in bugzero/WEB-INF/classes/project. You can copy the demo project
  97.      files demo_* to projectx_* and edit them accordingly. You might also need edit
  98.      the person file. Since you have only 5 users, the best way is perhap to drop the
  99.      demo project, and clean up everything (bugzero -drop demo, bugzero -drop all).
  100.      Then run bugzero -admin whateverPassword, and bugzero -create projectx.
  101.      This will create projectx. 
  102.  
  103.   6. Deploy to Servlet engine:
  104.  
  105.      Bugzero is deployed on a Servlet engine, you must
  106.  
  107.      a. Move the entire bugzero directory to your servlet engine's application
  108.         directory. Possible locations of this directory are:
  109.           Tomcat - .../webapps/
  110.           WebLogic - .../config/mydomain/applications/
  111.           WebSphere - .../AppServer/installableApps/
  112.  
  113.      b. After you dropped bugzero to the applications directory, Bugzero may
  114.         be deployed automatically (depending on the server and configuration).
  115.  
  116.      c. For some servers such as WebSphere, you may need make a war file from
  117.         the bugzero directory (to bugzero.war) and deploy this war file instead.
  118.         To make the war file, go inside the bugzero directory and type (without '')
  119.         'jar cvfM ../bugzero.war .', the resulted bugzero.war is in the same 
  120.         directory where bugzero is located.
  121.  
  122.  
  123. --------------------
  124. Start Servlet Engine
  125. --------------------
  126.   You should have
  127.  
  128.   1. installed and configured Bugzero.
  129.   2. moved the bugzero directory to the servlet engine's applications directory.
  130.  
  131.   You can now start (restart) the servlet engine. Please launch a browser,
  132.   and go to the url  http://localhost:port/bugzero/
  133.   you should see the welcome page.
  134.  
  135.  
  136. ---------
  137. Self Help
  138. ---------
  139.   If you encounter a problem, there are two places you should look at first.
  140.   One is the bugzero/WEB-INF/classes/log/bugzero.log file which records the runtime
  141.   information. The other one is faq.txt which may have already listed your problem
  142.   and had a solution.
  143.  
  144. ---------
  145. Questions
  146. ---------
  147. Bugzero homepage: http://www.websina.com/bugzero/
  148. If you have any questions, mailto: dev@websina.com
  149.