Skip to content

Latest commit

 

History

History
124 lines (77 loc) · 3.22 KB

INSTALL.md

File metadata and controls

124 lines (77 loc) · 3.22 KB

README | How to install | About the software package

Building and Installing

The DCM catalogue user interface

Getting started with dcm_catalog_ui

You will need an eXist DB installation. There are no special needs for that; just follow the manual.

To get a rudimentary installation follow the following procedure:

  1. Clone this repository
 git clone [email protected]:Det-Kongelige-Bibliotek/dcm_catalog_ui.git

or

https://github.com/Det-Kongelige-Bibliotek/dcm_catalog_ui.git
  1. Installation requires perl scripting language and ant build tool.
 cd dcm_catalog_ui

a. Installation on your local machine.

 ant service
 ant add_data
 ant upload

The last step (ant upload) requires the admin password of an eXist DB server on localhost, running on port 8080.

Having done these three steps you will have a everything installed on the server. It remains to make all scripts executable. You can do that for all of them in one go sending a GET request to the following URI

 http://localhost:8080/exist/rest/db/cat-site/xchmod.xq

Nothing will happen other than that your browser will prompt you for admin user ID and password. The script will return an empty document, and you can then easily verify that all scripts ending with *.xq now are ready to use.

b. Installation on a remote machine

The prerequisites are the same. The only difference being that ant upload now requires an extra option:

 ant upload -Dhostport=your.example.server:8080

c. Preparing your Apache HTTPD

You will not be able to run dcm_catalog_ui without an Apache to keep track of the URI space of the service. It might cause you headache, but for us it means that one server makes it all. We have four catalogues on the same site, working independently of each other.

The file cat-site.conf should be copied to the configuration directory of your HTTPD's virtual servers.

 <Location "/dcm/">

 RewriteEngine on

 RewriteCond %{REQUEST_URI}     .xq$
 RewriteRule (cnw|hartw|gw)/(.+).xq	http://localhost:8080/exist/rest/db/cat-site/$2.xq?c=$1 [P,QSA]

 RewriteCond  %{REQUEST_URI}     (cnw|hartw|gw)/(jquery|js|style|images|library|rism_sigla)/
 RewriteRule (cnw|hartw|gw)/(jquery|js|style|images|library|rism_sigla)/(.*)$ http://localhost:8080/exist/rest/db/cat-site/$2/$3 [P]

 RewriteCond  %{REQUEST_URI}     (editor|data.*)/(.*)$
 RewriteRule (editor|data.*)/(.*)$	http://localhost:8080/exist/rest/db/$1/$2 [P]

</Location>

After you've done that and restarted HTTPD, this means that if your eXist DB is on localhost:8080 and your HTTPD is on standard localhost:80, you will have one service at

http://localhost/dcm/cnw/navigation.xq

and

http://localhost/dcm/hartw/navigation.xq

However, only the former contains data.

d. Add server name to document.xq

If XSL transformation of data fails when trying to display a particular work record (i.e., URLs like http://your-server-name-here.org/dcm/cnw/document.xq?doc=nielsen_cnw0127.xml), you may need to add your server's name where indicated in the file document.xq, located in /db/cat-site/ in eXist:


declare variable $host  := "your-server-name-here.org";