2. Configuration

2.1. Configuration Files

There are several things that should be configured using configuration files. These include:

  • domain name in ege-webclient/WEB-INF/web.xml. You need to edit the file to add your domain name and port, e.g. instead of:

    <param-value>http://localhost:8080/ege-webservice/</param-value>

    you should put there something like:

    <param-value>http://www.your-domain.com:your-port/ege-webservice/</param-value>

If you leave the localhost settings in place, it might work for some browsers, but other browsers will not render the site, as they will consider the website is trying to do cross-site scripting (as localhost is a different domain name from www.your-domain.com).

  • OpenOffice.org home directory in ege-webservice/WEB-INF/lib/tei-config/configuration/OpenOfficeConfiguration. This file contains only one line, which should be a path to OpenOffice.org home directory, e.g.:

    /usr/lib/openoffice/

2.2. Other Configuration and Required Files

There is also some configuration which is coded in Java source files. If you have access to them, you can change these too, otherwise it is required that the files are located exactly where the servlet is trying to find them. Sometimes these locations are being referred to from several different places, so you might want to double check that you changed all of them.

  • tei-config directory – this directory contains links to stylesheets and local directory, both of which are needed for performing conversions. This directory should be located in WEB-INF/lib/ in the main webservice directory.
  • webservice/WEB-INF/lib/ – this directory should also contain all the necessary jar files (see the list below).
  • webservice/WEB-INF/config/ – this folder contains fileExt.xml file, which provides appropriate file extensions for all mime-types used in OxGarage.
  • webservice/WEB-INF/locale/ – here are located files hodling conversion properties descriptions displayed to the user. There is one file per language (currently English and Polish, but there are some things missing in the Polish version). However, as far as I know, the feature of choosing a language is not implemented yet. Nonetheless, at least one of these files is still required.

2.3. Read and Write Permissions Required

This service requires read permissions for the stylesheet directory and for the local directory, which are being linked to in the tei-config directory. It doesn't need write permissions for these directories. However, there are directories, which are used for caching and as temp directories.

Read permissions:

  • /usr/share/xml/tei/stylesheet
  • /usr/share/xml/tei/odd

    These are where the stylesheets are located when installed from their .deb package.

Read and write permissions:

  • In EGEConstants.java, there are Strings, which define a data directory for the service. The service uses this directory for caching and also as a temporary directory. Currently this directory is set to be a home directory of a user. On my machine it was /root/ directory. Hence it used /root/.ege as its data directory.

Up: Contents Previous: 1. Installation procedure Next: 3. List of .jar files which are built from the source of OxGarage