Quick Setup

From DBSight Full-Text Search Engine/Platform Wiki

Table of contents

System Requirements

  1. A Java application server, like Tomcat, Resin, etc
  2. JDK 1.6 or higher, make sure the command "java" is in the path
  3. JDBC Driver for your database, if it's not shipped.
  4. Database name, user name, user pasword. Only read access is needed.
  5. Know the SQLs to select the content. Just the table and column names are usually enough.

Settings for non ISO-8859-1 encoding

If you are using languages like German, Chinese, etc, you may need to adjust URI encoding setting. For example, Tomcat is using ISO-8859-1 as default. You can set the URIEncoding attribute on the <Connector> element in server.xml to something specific (e.g. URIEncoding="UTF-8").

   <Connector port="8080" protocol="HTTP/1.1" 
              connectionTimeout="20000" 
              URIEncoding="UTF-8"
              redirectPort="8443" />

Here you can find more about it: http://wiki.apache.org/tomcat/FAQ/CharacterEncoding

Installation Notes for Jetty

If you simply use Jetty without setting its temporary directory, your setting will be lost after restarting Jetty. This is because Jetty delete the files on exit.

More details can be found here (http://jetty.mortbay.org/jetty/faq?s=250-Configuration&t=210tempdir)

To prevent this, you can follow the instructions in the page to do one of the following:

  1. set javax.servlet.context.tempdir to a specific directory
  2. create directory WEB-INF/work
  3. create directory ${jetty.home}/work


Installation Notes for Apache Tomcat

  1. Start Tomcat
  2. Copy dbsight.war into tomcat's webapps folder, tomcat will automatically create a dbsight dir under webapps and extract the war file into dbsight dir
  3. Go to http://yourhost/dbsight/


Installation Notes for Resin

  1. Start Resin
  2. Copy dbsight.war into Resin's webapps folder, will automatically create a dbsight dir under webapps and extract the war file into dbsight dir
  3. Go to http://yourhost/dbsight/


Installation Notes for Jboss

  1. Create a folder named dbsight.war in the /server/deploy directory of your chosen configuration (all, default or minimal).
  2. Extract dbsight.war into the the dbsight.war/ directory.
  3. Start JBoss. Go to http://yourhost/dbsight/


Installation Notes for BEA Weblogic

Note: Another way to deploy on Weblogic is to Change Index Data Directory and create a deployable war file.

Need to manually extract dbsight.war content to a directory. This is because weblogic does not automatically unzip the war file. If not unzipped, NullPointerException will be thrown when trying to set the admin password during setup.

  1. Extract dbsight.war, using winzip or unzip. Extract the files into a directory or sub-directory named dbsight, for example C:\xxxx\dbsight
  2. Start the WebLogic Server Administration Console for the domain in which you will be working.
  3. In the left pane of the Console, expand the Deployments folder, right-click Web Application Modules, and select Deploy a New Web Application Module. This initiates the Deployment Assistant.
  4. Using the Deployment Assistant, locate the dbsight subdirectory which contains the exploded WAR files. WebLogic Server will deploy all components it finds in and below the specified directory.
  5. When you have located the dbsight sub directory to configure, click Target Application.
  6. If you have more than one server or cluster in your domain, select the one on which you want to deploy your new Web Application and click Continue. If you have just one server in your domain, go to the next step.
  7. Enter dbsight as the name for the Web Application in the Name field.
  8. Click Deploy. The Console displays the Deploy panel, which lists deployment status and deployment activities for the Web Application. After a few seconds, the status will change to "Success".
  9. Go to http://yourhost/dbsight in your browser and start using it

Installation Notes for IBM WebSphere

Need to manually extract dbsight.war content and let Websphere pick it up, instead of letting Websphere unzip the files for you.

Installation Notes for JRun

  1. Patch JRun to support JDK5
  2. Extract dbsight.war to a directory named dbsight, for example C:\xxxx\dbsight
  3. Move dbsight/WEB-INF/lib/log4j.jar into $JRUN/servers/lib/ (create this directory if it doesn't exist) btw: do not delelte dbsight/WEB-INF/lib/commons-logging.jar. If it's causing problem, copying JRun's version here.
  4. For DBSight 1.x, Remove file dbsight/WEB-INF/lib/ext/jdbc/mysql*.jar, copy the mysql jdbc driver that JRun shipped as default to here.
  5. In the left pane of the Console, Select default | J2EE Components.
  6. In the right pane of the Console, click on the Add button under Web Applications.
  7. In the field Source File Path, enter the name of the directory where the files extracted from dbsight.war are present.
  8. Click on the Deploy button.
  9. Under "General Settings for dbsight", enter /dbsight in the Context Path field and click Apply.
  10. Go to http://yourhost/dbsight in your browser and start using it