# HG changeset patch # User robcast # Date 1052862034 -7200 # Node ID ffc7d913839714fec708f2d3427e6318433c39ce # Parent 19edc2593b883af302309630b2c926769f139949 Updated for alcatraz/digilib 1.3 and up. diff -r 19edc2593b88 -r ffc7d9138397 docu/installation.html --- a/docu/installation.html Tue May 13 21:02:16 2003 +0200 +++ b/docu/installation.html Tue May 13 23:40:34 2003 +0200 @@ -1,27 +1,26 @@ -Installation of digilib +Installation of alcatraz/digilib

What you need to install digilib

Java JDK >1.2 (preferred 1.3)
Java JDK >1.2 (preferred 1.4 and up)
Jakarta - tomcat version 4.0.1 from + Tomcat version 4 or later (preferred 4.1 and up) from http://jakarta.apache.org
The digilib distribution packages (from http://developer.berlios.de)
- digilib scripts and servlets package - digilib-core.zip
- alcatraz/digilib scripts and servlets package + alcatraz-core.zip
- digilib configuration files for tomcat 4 package - digilib-tomconf.zip
- digilib external libraries package digilib-ext.zip - (Not essential. Contains documentation to JAI 1.1.1 and Xerces - 1.4.3)

@@ -31,35 +30,48 @@

On Linux

Make shure Java JDK is installed
Make shure the Java JDK is installed (a JRE won't do).
Create a base directory for docuserver (the default used here is /docuserver) and for the web interface (/docuserver/www).
Unpack the digilib-core package in the web + +
Unpack the alcatraz-core package in the web interface directory (/docuserver/www). This will create the digilib directory digitallibrary.
(optional) Unpack the digilib-ext package in the - docuserver directory.
Unpack Jakarta tomcat 4.0.1 in /opt This should - produce a directory /opt/jakarta-tomcat-4.0.1. Create a - link /opt/tomcat to the new directory.
Unpack the configuration files package + +
Unpack Jakarta Tomcat 4.1.24 in /docuserver This should + produce a directory /docuserver/jakarta-tomcat-4.1.24. Create a + link /docuserver/tomcat to the new directory.
(optional) Unpack the configuration files package digilib-tomconf in the tomcat directory.
Adjust hostname and HTML-base directory in the file - server.xml (in the directory - /opt/tomcat/conf, see below for details))
Create a link from the digilib directory into the Tomcat webapps + directory /docuserver/tomcat/webapps (type ln -s + /docuserver/www/digitallibrary /docuserver/tomcat/webapps) This is + the default installation running on port 8080 as + http://myserver:8080/digitallibrary/.
Adjust the path to the JDK and its options in catalina.sh (in the directory - /opt/tomcat/bin, see below for details)

/docuserver/tomcat/bin

(optional) For SuSE Linux you can use the startup skript tomcat/bin/rctomcat to start and stop the tomcat server. Copy the script into /etc/init.d as tomcat and set runlevel links accordingly.
(optional) Set the tomcat directory and all files to be owned by - the user - wwwrun (or whatever your webserver runs) and use this - account to start the tomcat server.

wwwrun

to use Mozilla-XUL functionality a user have to open the page + http://myserver:8080/digitallibrary/xul/install_sidebar.jsp + in a mozilla compatible browser and press the button 'install button + list into sidebar'

@@ -82,9 +94,9 @@

catalina.sh

The file catalina.sh (in /opt/tomcat/bin -has been modified to provide the path to the JDK and runtime options -for the Java VM. Somewhere at the beginning of the file are two lines +

The file catalina.sh (in /docuserver/tomcat/bin +can be modified to provide the path to the JDK and runtime options +for the Java VM. Somewhere at the beginning of the file you can put two lines like this:

@@ -98,82 +110,14 @@
 
 You can delete those two lines if you set these variables in your
 shell before starting tomcat in that same shell. These lines are
-needed if you want to use the startup script for linux mentioned
-above.
-
-
-server.xml
-
-The environment of the tomcat server is configured in the file
-server.xml in /opt/tomcat/conf. Extensive documentation
-about all options can by found on the webpages of the tomcat
-project.
-
-A minimal configuration file for running digilib is provided in the
-digilib-tomconf package. For standard operation only a
-few adjustments have to be made. The configuration file should look
-like this:
-
--<!-- Digilib Server Configuration File -->
-
-<Server port="8005" shutdown="SHUTDOWN" debug="0">
-
-  <!-- Define an Apache-Connector Service -->
-  <Service name="Tomcat-Docuserver">
-
-    <!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
-    <Connector className="org.apache.catalina.connector.http.HttpConnector"
-               port="8080" minProcessors="5" maxProcessors="75"
-               acceptCount="10" debug="0" connectionTimeout="60000"/>
-
-    <!-- Replace "localhost" with what your Apache "ServerName" is set to -->
-    <Engine className="org.apache.catalina.connector.warp.WarpEngine"
-     name="Apache" debug="1" appBase="webapps" defaultHost="hera.unibe.ch">
-
-      <!-- Global logger unless overridden at lower levels -->
-      <Logger className="org.apache.catalina.logger.FileLogger"
-              prefix="apache_log." suffix=".txt"
-              timestamp="true"/>
-
-      <!-- Define the default virtual host. Hostname must match the engine's. -->
-      <Host name="hera.unibe.ch" debug="0" appBase="/docuserver/www">
-
-        <Context path="/docuserver/digitallibrary" docBase="/docuserver/www/digitallibrary" debug="0" reloadable="false">
-	</Context>
-
-      </Host>
-
-      <!-- Because this Realm is here, an instance will be shared globally -->
-      <Realm className="org.apache.catalina.realm.MemoryRealm" />
-
-    </Engine>
-
-  </Service>
-
-</Server>
-
-
-You can change the portnumber of your server to be something other
-than 8080 in the port property. If you want to use the
-default webserver port 80 you have to run tomcat as the root user (it
-is less secure to do this!).
-
-You have to change the occurences of hera.unibe.ch (in
-the defaultHost and name properties) to your
-hostname.
-
-Then you can adjust the /docuserver/www path to the
-directory where you installed the digilib-core
-package. You should not change the path property but only
-the appBase and docBase properties!
+needed if you want to use the startup script mentioned above under
+linux .
 
 
 tomcat-users.xml
 
 All passwords and usernames have to be set up in the file
-tomcat-users.xml in /opt/tomcat/conf if you
+tomcat-users.xml in /docuserver/tomcat/conf if you
 want to use authentication in digilib. The file looks like this:
 
 @@ -192,9 +136,14 @@
 an authenticated user is allowed to access a document (see
 digilib-auth.xml below).
 
+If you want to use the webinterface to configure Tomcat, you have to
+add administrational account with the roles admin and
+manager.
+
 tomcat has to be restarted before changes to
 tomcat-users.xml have effect!
 
+
 Digilib
 
 web.xml
@@ -204,7 +153,7 @@
 the digilib directory
 (/docuserver/www/digitallibrary/WEB-INF).
 
-The only parameter you might have to adjust is the position of the
+
The only parameter you will have to adjust is the position of the
 digilib configuration file. The parameter occurs twice in the file and
 looks like this:
 
@@ -218,10 +167,11 @@
 </init-param>
 
 
-Change the path to where you installed the configuration files.
+Change the path to point where you installed the configuration files.
 
-Make shure to change the parameter in both places! It is needed
-both for the servlet and the JSP pages!
+Make shure to change the parameter in both places in the config
+file! It is needed both for the servlet and the JSP pages!
+
 
 digilib-config.xml
 
@@ -246,8 +196,9 @@
   <parameter name="denied-image" value="/docuserver/images/icons/alert.red.gif" />
 
   <!-- List of directories where images are searched.
-       Directories with low-resolution images are first in list. -->
-  <parameter name="basedir-list" value="/docuserver/scaled/small:/docuserver/images:/docuserver/scans/quellen" />
+       The authoritative directory with the high-resolution images
+       is first in list. -->
+  <parameter name="basedir-list" value="/docuserver/images:/docuserver/scaled/small" />
 
   <!-- Restrict access to authorized users.
        User authentication and roles are provided by the servlet container 
@@ -256,7 +207,7 @@
        (see auth-file). -->
   <parameter name="use-authorization" value="true" />
 
-  <!-- 	  URL location of XML file with authorization requirements. -->
+  <!-- Location of XML file with authorization requirements. -->
   <parameter name="auth-file" value="/docuserver/www/digitallibrary/WEB-INF/digilib-auth.xml" />
 
   <!-- Part of URL to indicate authenticated access to Tomcat. -->
@@ -267,7 +218,8 @@
 You have to adjust the basedir-list parameter to the
 directories where your images are installed. You need only one
 directory if you do not have prescaled low resolution versions of your
-images.
+images. The directory with the high-resolution versions must be the
+first entry in the list.
 
 You can supply your own images for the "error" and
 "access denied" messages by the servlet. Standard images
@@ -332,5 +284,5 @@
 
 

 robert.casties@philo.unibe.ch
- Last modified: Thu Jan 17 19:12:01 CET 2002 
+Last modified: Tue May 13 23:35:13 CEST 2003