Mercurial > hg > digilib

annotate doc/src/site/markdown/install-digilib.md @ 1279:828b6c8b1b19

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