Mercurial > hg > digilib

comparison install-digilib.html @ 1640:1ae8b89d3a86

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Creating site for 2.5-SNAPSHOT
author Robert Casties <casties@mpiwg-berlin.mpg.de>
date Tue, 22 Aug 2017 16:38:19 +0000
parents
children 16be3440305b
comparison
equal deleted inserted replaced
-1:000000000000 1640:1ae8b89d3a86
1 <!DOCTYPE html>
2 <!--
3 | Generated by Apache Maven Doxia at 2017-08-22
4 | Rendered using Apache Maven Fluido Skin 1.3.0
5 -->
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20170822" />
11 <meta http-equiv="Content-Language" content="en" />
12 <title>digilib - The Digital Image Library &#x2013; Installing digilib</title>
13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" />
16
17
18 <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
19
20
21 </head>
22 <body class="topBarDisabled">
23
24
25
26 <div class="container-fluid">
27 <div id="banner">
28 <div class="pull-left">
29 <a href="./" id="bannerLeft">
30 <h2>digilib - a versatile image viewing environment for the internet</h2>
31 </a>
32 </div>
33 <div class="pull-right"> <a href="./" id="bannerRight">
34 <img src="images/digilib-logo-small.png" />
35 </a>
36 </div>
37 <div class="clear"><hr/></div>
38 </div>
39
40 <div id="breadcrumbs">
41 <ul class="breadcrumb">
42
43
44 <li id="publishDate">Last Published: 2017-08-22</li>
45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>
46
47
48
49
50 </ul>
51 </div>
52
53
54 <div class="row-fluid">
55 <div id="leftColumn" class="span3">
56 <div class="well sidebar-nav">
57
58
59 <ul class="nav nav-list">
60 <li class="nav-header">Overview</li>
61
62 <li>
63
64 <a href="index.html" title="About digilib">
65 <i class="none"></i>
66 About digilib</a>
67 </li>
68
69 <li>
70
71 <a href="features.html" title="digilib features">
72 <i class="none"></i>
73 digilib features</a>
74 </li>
75
76 <li>
77
78 <a href="digilib-short.html" title="How digilib works">
79 <i class="none"></i>
80 How digilib works</a>
81 </li>
82
83 <li>
84
85 <a href="history.html" title="Ancient history">
86 <i class="none"></i>
87 Ancient history</a>
88 </li>
89 <li class="nav-header">Installation</li>
90
91 <li class="active">
92
93 <a href="#"><i class="none"></i>Installing digilib</a>
94 </li>
95
96 <li>
97
98 <a href="build-maven.html" title="Building digilib">
99 <i class="none"></i>
100 Building digilib</a>
101 </li>
102 <li class="nav-header">Configuration</li>
103
104 <li>
105
106 <a href="digilib-config.html" title="Configuring digilib">
107 <i class="none"></i>
108 Configuring digilib</a>
109 </li>
110
111 <li>
112
113 <a href="image-directories.html" title="Directory layout">
114 <i class="none"></i>
115 Directory layout</a>
116 </li>
117
118 <li>
119
120 <a href="java-settings.html" title="Java settings and tuning">
121 <i class="none"></i>
122 Java settings and tuning</a>
123 </li>
124
125 <li>
126
127 <a href="auth.html" title="Access control">
128 <i class="none"></i>
129 Access control</a>
130 </li>
131 <li class="nav-header">Development</li>
132
133 <li>
134
135 <a href="scaler-api.html" title="The digilib Scaler API">
136 <i class="none"></i>
137 The digilib Scaler API</a>
138 </li>
139
140 <li>
141
142 <a href="iiif-api.html" title="The digilib IIIF API">
143 <i class="none"></i>
144 The digilib IIIF API</a>
145 </li>
146
147 <li>
148
149 <a href="client-integration.html" title="Integrating digilib into your page">
150 <i class="none"></i>
151 Integrating digilib into your page</a>
152 </li>
153
154 <li>
155
156 <a href="plugins.html" title="Digilib plugins">
157 <i class="none"></i>
158 Digilib plugins</a>
159 </li>
160 <li class="nav-header">Project Documentation</li>
161
162 <li>
163
164 <a href="project-info.html" title="Project Information">
165 <i class="icon-chevron-right"></i>
166 Project Information</a>
167 </li>
168 </ul>
169
170
171
172 <hr class="divider" />
173
174 <div id="poweredBy">
175 <div class="clear"></div>
176 <div class="clear"></div>
177 <div class="clear"></div>
178 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy">
179 <img class="builtBy" alt="Built by Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
180 </a>
181 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy">
182 <img class="builtBy" alt="Hosted by SourceForge" src="http://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" />
183 </a>
184 </div>
185 </div>
186 </div>
187
188
189 <div id="bodyColumn" class="span9" >
190
191 <h1>Installing digilib</h1>
192 <p>To run digilib you need:</p>
193
194 <ul>
195
196 <li><a class="externalLink" href="http://www.java.com/">Java</a> (1.6 or higher)</li>
197
198 <li>a Servlet Container like <a class="externalLink" href="http://tomcat.apache.org/">Tomcat</a> (version 7 or higher) or <a class="externalLink" href="http://www.eclipse.org/jetty/">Jetty</a> (version 8 or higher)</li>
199
200 <li>the digilib web application as a WAR file or application directory</li>
201 </ul>
202 <div class="section">
203 <h2><a name="Run_the_Servlet_Container"></a>Run the Servlet Container</h2>
204 <p>Install and run the Servlet Container of your choice: <a class="externalLink" href="http://tomcat.apache.org/tomcat-7.0-doc/setup.html">Tomcat</a> or <a class="externalLink" href="http://wiki.eclipse.org/Jetty/Howto/Run_Jetty">Jetty</a>.</p>
205 <p>When it runs you should be able to access the start page on <a class="externalLink" href="http://localhost:8080/">http://localhost:8080/</a></p></div>
206 <div class="section">
207 <h2><a name="Install_a_digilib_WAR_file"></a>Install a digilib WAR file</h2>
208
209 <ol style="list-style-type: decimal">
210
211 <li>Download a digilib WAR file of a recent digilib release from the SourceForge <a class="externalLink" href="https://sourceforge.net/projects/digilib/files/">Download page</a> or the latest digilib build from the <a class="externalLink" href="https://it-dev.mpiwg-berlin.mpg.de/downloads/digilib/daily-build/">daily build page</a>.</li>
212
213 <li>Rename the WAR file to <tt>digilib.war</tt>.</li>
214
215 <li>Deploy the WAR file, i.e. drop it into the <tt>webapps</tt> directory of your Servlet Container.</li>
216
217 <li>Restart your Servlet Container (this may not be necessary).</li>
218
219 <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a>.</li>
220 </ol>
221 <p>You will now be able to see the sample images provided with the digilib installation.</p>
222 <p>If you want to use digilib to show your own images you have to change the configuration file <a href="digilib-config.html">digilib-config.xml</a> <b>inside</b> the web application. This is hard to do with a WAR file so its better to deploy digilib as a web application directory.</p></div>
223 <div class="section">
224 <h2><a name="Install_digilib_as_a_web_application_directory"></a>Install digilib as a web application directory</h2>
225 <p>Unpack the WAR file into a directory called <tt>digilib</tt> using an unzip tool or the <tt>jar -xf</tt> Java command. </p>
226 <p>Alternatively you can look into the <tt>webapps</tt> directory of your Servlet Container (when its not running) to see if it created an unpacked web application directory called <tt>digilib</tt>.</p>
227 <p>Alternatively you can build your own version of digilib as documented <a href="build-maven.html">here</a>.</p>
228 <p>Then:</p>
229
230 <ol style="list-style-type: decimal">
231
232 <li>Make sure that your Servlet Container is not running and remove any <tt>digilib.war</tt> files from the <tt>webapps</tt> directory.</li>
233
234 <li>Copy your <tt>digilib</tt> directory into the <tt>webapps</tt> directory of the Servlet Container.</li>
235
236 <li>Edit the <tt>digilib-config.xml</tt> file in the <tt>WEB-INF</tt> subdirectory of the <tt>digilib</tt> directory and adjust the <tt>basedir-list</tt> parameter to point to the directory with your image files <a href="digilib-config.html">according to the documentation</a>. If there is no file <tt>digilib-config.xml</tt> you can either create a new file or rename the sample file <tt>digilib-config.xml.template</tt> to <tt>digilib-config.xml</tt> and edit it.</li>
237
238 <li>Start your Servlet Container.</li>
239
240 <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a></li>
241 </ol>
242 <p>You can now view your own images in digilib by providing the directory and file name as the <tt>fn</tt> parameter to <tt>digilib.html</tt>, e.g. if your file is called <tt>flower.jpg</tt> and it is in a subdirectory of the base directory called <tt>digilib-test</tt> you can now access the URL</p>
243 <p><a class="externalLink" href="http://localhost:8080/digilib/digilib.html?fn=digilib-test/flower">http://localhost:8080/digilib/digilib.html?fn=digilib-test/flower</a></p>
244 <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div>
245 </div>
246 </div>
247 </div>
248
249 <hr/>
250
251 <footer>
252 <div class="container-fluid">
253 <div class="row span12">Copyright &copy; 2001-2017
254 <a href="http://digilib.sourceforge.net">digilib Community</a>.
255 All Rights Reserved.
256
257 </div>
258
259
260
261 </div>
262 </footer>
263 </body>
264 </html>