Mercurial > hg > digilib

comparison doc/src/site/markdown/install-digilib.md @ 1273:30ec52034355

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added some forgotten docs.
author robcast
date Fri, 31 Jan 2014 12:26:08 +0100
parents
children 828b6c8b1b19
comparison
equal deleted inserted replaced
1272:d0c99b2d7234 1273:30ec52034355
1 # Installing digilib
2
3 To run digilib you need:
4
5 * [Java](http://www.java.com/) (1.6 or higher)
6 * a Servlet Container like [Tomcat](http://tomcat.apache.org/) (version 7 or
7 higher) or [Jetty](http://www.eclipse.org/jetty/) (version 8 or higher)
8 * the digilib web application as a WAR file or application directory
9
10 ## Run the Servlet Container
11
12 Install and run the Servlet Container of your choice:
13 [Tomcat](http://tomcat.apache.org/tomcat-7.0-doc/setup.html) or
14 [Jetty](http://wiki.eclipse.org/Jetty/Howto/Run_Jetty).
15
16 When it runs you should be able to access the start page on
17 <http://localhost:8080/>
18
19 ## Install a digilib WAR file
20
21 1. Download a digilib WAR file of a recent digilib release from the
22 BerliOS [Download page](http://developer.berlios.de/project/showfiles.php?group_id=251)
23 or the latest digilib build from the
24 [daily build page](http://digilib.berlios.de/downloads/daily-build/).
25 2. Rename the WAR file to `digilib.war`.
26 3. Deploy the WAR file, i.e. drop it into the `webapps` directory of your
27 Servlet Container.
28 4. Restart your Servlet Container (this may not be necessary).
29 5. Access your digilib instance at <http://localhost:8080/digilib/digilib.html>.
30
31 You will now be able to see the sample images provided with the digilib
32 installation.
33
34 If you want to use digilib to show your own images you have to change the
35 configuration file [digilib-config.xml](digilib-config.html) **inside** the
36 web application. This is hard to do with a WAR file so its better to
37 deploy digilib as a web application directory.
38
39 ## Install digilib as a web application directory
40
41 Unpack the WAR file into a directory called `digilib` using
42 an unzip tool or the `jar -xf` Java command.
43
44 Alternatively you can look into the `webapps` directory of your Servlet
45 Container (when its not running) to see if it created an unpacked web
46 application directory called `digilib`.
47
48 Alternatively you can build your own version of digilib as documented
49 [here](build-maven.html).
50
51 Then:
52
53 1. Make sure that your Servlet Container is not running and remove any
54 `digilib.war` files from the `webapps` directory.
55 2. Copy your `digilib` directory into the `webapps` directory of the
56 Servlet Container.
57 3. Edit the `digilib-config.xml` file in the `WEB-INF` subdirectory of the
58 `digilib` directory and adjust the `basedir-list` parameter to point to
59 the directory with your image files [according to the
60 documentation](digilib-config.html). If there is no file `digilib-config.xml`
61 you can either create a new file or rename the sample file
62 `digilib-config.xml.template` to `digilib-config.xml` and edit it.
63 4. Start your Servlet Container.
64 5. Access your digilib instance at <http://localhost:8080/digilib/digilib.html>
65
66 You can now view your own images in digilib by providing the directory and file
67 name as the `fn` parameter to `digilib.html`, e.g. if your file is called
68 `flower.jpg` and it is in a subdirectory of the base directory called
69 `digilib-test` you can now access the URL
70
71 <http://localhost:8080/digilib/digilib.html?fn=digilib-test/flower>
72
73 Read more about the layout of image files and directories
74 [here](image-directories.html).