Index
Downloads
Documentation
Technologies
Architecture
Screenshots
Release Notes
API Docs
Install
Installation on JServ
Installation on Tomcat
Installation on Resin
Code Repository
Mail Lists
Live Demo
Credits
SourceForge Logo
Sourceforge Project Page

Requirements

Jakarta Tomcat installation

 

Requirements

This document describes the webEditor installation procedure under the newest Apache Group Servlet Engine: Jakarta Tomcat.

webEditor has been tested with the latest stable release of Tomcat, 3.2.1. If you successfully install webEditor under another version of Tomcat, please, make us know.

Jakarta-Tomcat supports a large number of web servers as backends for the static content. We are going to suppose that you are using Apache v1.3.x, because is, by large, the best Web Server that you will find ;-).

For generic recommendations, please, read the webEditor generic installation document

 

Jakarta Tomcat installation

First at all, you have to download the webEditor latest release from our web site http://sourceforge.net/projects/webeditor

webEditor now comes with a war (Web Application archive) file, ready to install in any J2EE compatible engine, for example in Tomcat. Once you download webEditor.war file you should place it under the webapps Tomcat directory, typically in $TOMCAT_HOME/webapps

Tomcat will uncompress this file to the webapps/webEditor directory at boot time. However, is better that you perform this operation manually, because webEditor is not yet "ready to go":

# mkdir webEditor

# cp webEditor.war webEditor

# cd webEditor

# jar -xvf webEditor.war

In order to set up webEditor properly, you must edit the servlet descriptor file, placed in WEB-INF/web.xml:

<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE web-app

PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"

"http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">

<web-app>

<servlet>

<servlet-name>wEd</servlet-name>

<servlet-class>webEditor.wEd</servlet-class>

<init-param>

<param-name>wEd_root</param-name>

<param-value>[$TOMCAT_HOME]webapps/webEditor/editor_1</param-value>

</init-param>

</servlet>

</web-app>

Then, change $TOMCAT_HOME for the proper value for your system.

The last step is to change the webEditor main configuration file. You will find this in $TOMCAT_HOME/webapps/webEditor/editor_1/general.xml:

<!-- Sample configuration file for the example editor -->

<general>

<category name="directories">

<!-- General name of the editor-->

<data code="editorName">editor_1</data>

<!-- Web Server primary document directory-->

<!-- Please, change this parameter to your proper value-->

<data code="serverRoot">/usr/local/jakarta-tomcat-3.2.1/webapps</data>

<!-- Name of the Web Server in whitch you want to PUBLISH-->

<!-- note that this is not necesary your edition server -->

<data code="serverName">localhost</data>

<!-- Editor primary directory (Relative to the root directory) -->

<data code="docRoot">webEditor/myNews</data>

<!-- Related images directory (Relative to the root directory) -->

<data code="imgDir">webEditor/myNews/images</data>

<!-- Temporal Directory in whitch to store the uploaded images -->

<data code="tmpDir">/tmp</data>

<!-- Editor data directory (Relative to the root directory) -->

<data code="dataDir">data</data>

<!-- XSL templates directory (relative to the data directory) -->

<data code="tplDir">templates</data>

<!-- File with the list of the xml files taht forms the Home Page -->

<data code="homePage">homePage.xml</data>

</category>

</general>

There, you should change the variables named serverRoot, docRoot, imgDir and tmpDir for values that match with your system settings. As a general rule, serverRoot must be the webapps directory of Tomcat.

 

NOTE: Standard distributions of Tomcat come with a XML parser (parser.jar, placed onto the lib directory). This may cause you problems, because webEditor comes with it's own XML parser (Xerces). A possible workaround is to delete the parser.jar and javax.jar file form the lib directory and use instead the xerces.jar file that comes with webEditor.

NOTE: webEditor doesn't work with the latest Xerces distribution 1.3.0. While we solve this problem, we recommend you to use Xerces 1.2.2

Don't forget to grant write access to the news directory for your webEditor SO user!!.

Well, that's all. You only have to restart Tomcat and take a look the webEditor main URL:

http://localhost/webEditor

If everything is ok, you will see this pretty cool page: