home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 May / CMCD0505.ISO / Software / Shareware / Programare / bugzero / WEB-INF / README.txt < prev    next >
Text File  |  2004-12-01  |  7KB  |  165 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, extract bugzero into a temp directory. 
  41.  
  42.   2. Under directory ../bugzero/WEB-INF, run 'setup'.
  43.  
  44.      This setup program will guide you through all the system configurations
  45.      including the database, the email account, and the servlet engine.
  46.      It will also instruct you where to deploy Bugzero.
  47.  
  48.      Note that, on Unix/Linux OS, you may need do 'chmod +x setup.sh' to make it
  49.      executable. You may also need type ./setup.sh instead of just setup.sh.
  50.  
  51. -------------------
  52. Manual Installation
  53. -------------------
  54.   
  55.   If your environment does not have the graphics support to run the setup program,
  56.   you can configure the system with the following manual steps:
  57.  
  58.   1. Database server properties
  59.  
  60.      Modify the file, bugzero/WEB-INF/classes/conf/db.properties
  61.      a) set the database name, bugzero.database=databaseX
  62.         here databaseX can be one of
  63.         access, mssql, mysql, oracle, db2, postgresql, sybase, and pointbase. 
  64.      b) set the url, user, password of the corresponding databaseX.
  65.  
  66.   2. JDBC driver
  67.  
  68.      For databases Access and MySQL, the JDBC driver is already provided and nothing
  69.      need to do done. If you are using Oracle, SQL Server, DB2, etc, you need add
  70.      the corresponding JDBC driver into the lib directory (bugzero/WEB-INF/lib).
  71.  
  72.  
  73.   3. Mail server properties
  74.  
  75.      Modify the file, bugzero/WEB-INF/classes/conf/mail.properties
  76.         mail.smtp.host=
  77.         mail.smtp.from=
  78.         mail.username=
  79.         mail.password=
  80.  
  81.   4. Create tables (command-line)
  82.  
  83.      Under directory ../bugzero/WEB-INF/bin, first run 
  84.  
  85.      'bugzero -test' to test the database connection. If it connects, then run
  86.  
  87.      'bugzero -admin whateverPassword' to create all the base tables as well as 
  88.  
  89.      the administration account. The administration account is required for 
  90.      managing the project and user accounts through the web interface.
  91.  
  92.      (Optional) To create the demo project, run 'bugzero -create demo'.
  93.      This will create the demo tables based on the project/demo_* files (included). 
  94.  
  95.      Note that, on Unix/Linux OS, you may need do 'chmod +x bugzero.sh' to make it
  96.      executable. You may also need type ./bugzero.sh instead of just bugzero.sh.
  97.  
  98.   5. Create your project (only for try edition)
  99.  
  100.      To manually create a project projectx, you must first have all the project
  101.      files in place in bugzero/WEB-INF/classes/project. You can copy the demo project
  102.      files demo_* to projectx_* and edit them accordingly. You might also need edit
  103.      the person file. Since you have only 5 users, the best way is perhap to drop the
  104.      demo project, and clean up everything (bugzero -drop demo, bugzero -drop all).
  105.      Then run bugzero -admin whateverPassword, and bugzero -create projectx.
  106.      This will create projectx. 
  107.  
  108.   6. Deploy to Servlet engine:
  109.  
  110.      Bugzero is deployed on a Servlet engine, you must
  111.  
  112.      a. Move the entire bugzero directory to your servlet engine's application
  113.         directory. Possible locations of this directory are:
  114.           Tomcat - .../webapps/
  115.           WebLogic - .../config/mydomain/applications/
  116.  
  117.      b. After you dropped bugzero to the applications directory, Bugzero may
  118.         be deployed automatically (depending on the server and configuration).
  119.  
  120.      c. For some servers such as WebSphere, you may need make a bugzero.war file
  121.         from the bugzero directory and deploy this war file instead.
  122.         To make the war file, go inside the bugzero directory and type (without '')
  123.         'jar cvfM ../bugzero.war .', the resulted bugzero.war is in the same 
  124.         directory where bugzero is located.
  125.  
  126.      For more details, consult the corresponding file under WEB-INF/classes/install.
  127.  
  128.  
  129. --------------------
  130. Start Servlet Engine
  131. --------------------
  132.   You should already have
  133.  
  134.   1. installed and configured Bugzero.
  135.   2. moved the bugzero directory to the servlet engine's applications directory.
  136.  
  137.   You can now start (restart) the servlet engine. Please launch a browser,
  138.   and go to the url  http://localhost:port/bugzero/
  139.   you should see the welcome page. (replace port with the actual port number of
  140.   your servlet engine, and localhost of the proper url)
  141.  
  142.   How to start your servlet engine with command-line (just an example):
  143.  
  144.     Tomcat:     under bin dir, cataline run
  145.     WebLogic:   under server/mydomain dir, startWeblogic
  146.     WebSphere:  UI based
  147.     Oracle9iAS: under j2ee/home/, java -jar oc4j.jar
  148.     Orion:      under Orion, java -jar orion.jar
  149.     Resin:      under bin dir, httpd
  150.  
  151.  
  152. ---------
  153. Self Help
  154. ---------
  155.   If you encounter a problem, there are two places you should look at first.
  156.   One is the bugzero/WEB-INF/classes/log/bugzero.log file which records the runtime
  157.   information. The other one is faq.txt which may have already listed your problem
  158.   and had a solution.
  159.  
  160. ---------
  161. Questions
  162. ---------
  163. Bugzero homepage: http://www.websina.com/bugzero/
  164. If you have any questions, mailto: dev@websina.com
  165.