Mercurial > hg > digilib

comparison install-digilib.html @ 1659:fe8300fdcd9d

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 Mon, 20 Nov 2017 20:24:00 +0000
parents 636e7342b1b6
children 1beeb9319d78
comparison
equal deleted inserted replaced
1642:636e7342b1b6 1659:fe8300fdcd9d
1 <!DOCTYPE html> 1 <!DOCTYPE html>
2 <!-- 2 <!--
3 | Generated by Apache Maven Doxia at 2017-08-22 3 | Generated by Apache Maven Doxia at 2017-11-20
4 | Rendered using Apache Maven Fluido Skin 1.3.0 4 | Rendered using Apache Maven Fluido Skin 1.3.0
5 --> 5 -->
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head> 7 <head>
8 <meta charset="UTF-8" /> 8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20170822" /> 10 <meta name="Date-Revision-yyyymmdd" content="20171120" />
11 <meta http-equiv="Content-Language" content="en" /> 11 <meta http-equiv="Content-Language" content="en" />
12 <title>digilib - The Digital Image Library &#x2013; Installing digilib</title> 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" /> 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
14 <link rel="stylesheet" href="./css/site.css" /> 14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" /> 15 <link rel="stylesheet" href="./css/print.css" media="print" />
39 39
40 <div id="breadcrumbs"> 40 <div id="breadcrumbs">
41 <ul class="breadcrumb"> 41 <ul class="breadcrumb">
42 42
43 43
44 <li id="publishDate">Last Published: 2017-08-22</li> 44 <li id="publishDate">Last Published: 2017-11-20</li>
45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li> 45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>
46 46
47 47
48 48
49 49
86 <i class="none"></i> 86 <i class="none"></i>
87 Ancient history</a> 87 Ancient history</a>
88 </li> 88 </li>
89 <li class="nav-header">Installation</li> 89 <li class="nav-header">Installation</li>
90 90
91 <li>
92
93 <a href="build-maven.html" title="Building digilib">
94 <i class="none"></i>
95 Building digilib</a>
96 </li>
97
91 <li class="active"> 98 <li class="active">
92 99
93 <a href="#"><i class="none"></i>Installing digilib</a> 100 <a href="#"><i class="none"></i>Installing digilib</a>
94 </li> 101 </li>
95 102
96 <li> 103 <li>
97 104
98 <a href="build-maven.html" title="Building digilib"> 105 <a href="server-setups.html" title="Server setups">
99 <i class="none"></i> 106 <i class="none"></i>
100 Building digilib</a> 107 Server setups</a>
101 </li> 108 </li>
102 <li class="nav-header">Configuration</li> 109 <li class="nav-header">Configuration</li>
103 110
104 <li> 111 <li>
105 112
176 <div class="clear"></div> 183 <div class="clear"></div>
177 <div class="clear"></div> 184 <div class="clear"></div>
178 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy"> 185 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy">
179 <img class="builtBy" alt="Built by Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> 186 <img class="builtBy" alt="Built by Maven" src="https://maven.apache.org/images/logos/maven-feather.png" />
180 </a> 187 </a>
181 <a href="https://github.com/" title="Hosted by GitHub" class="builtBy"> 188 <a href="../../" title="Hosted by GitHub" class="builtBy">
182 <img class="builtBy" alt="Hosted by GitHub" src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Logo.png" width="200px" /> 189 <img class="builtBy" alt="Hosted by GitHub" src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Logo.png" width="200px" />
183 </a> 190 </a>
184 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy"> 191 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy">
185 <img class="builtBy" alt="Hosted by SourceForge" src="https://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" /> 192 <img class="builtBy" alt="Hosted by SourceForge" src="https://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" />
186 </a> 193 </a>
194 <h1>Installing digilib</h1> 201 <h1>Installing digilib</h1>
195 <p>To run digilib you need:</p> 202 <p>To run digilib you need:</p>
196 203
197 <ul> 204 <ul>
198 205
199 <li><a class="externalLink" href="http://www.java.com/">Java</a> (1.6 or higher)</li> 206 <li><a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java JDK</a> (7 or higher)</li>
200 207
201 <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> 208 <li>a Servlet Container like <a class="externalLink" href="http://tomcat.apache.org/">Tomcat</a> (version 7 or later) or <a class="externalLink" href="http://www.eclipse.org/jetty/">Jetty</a> (version 8 or later)</li>
202 209
203 <li>the digilib web application as a WAR file or application directory</li> 210 <li>the digilib web application as a WAR file or application directory</li>
204 </ul> 211 </ul>
205 <div class="section"> 212 <div class="section">
206 <h2><a name="Run_the_Servlet_Container"></a>Run the Servlet Container</h2> 213 <h2><a name="Start_the_Servlet_Container"></a>Start the Servlet Container</h2>
207 <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> 214 <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>
208 <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> 215 <p>When the Servlet Container runs you should be able to access the start page on <a class="externalLink" href="http://localhost:8080/">http://localhost:8080/</a></p></div>
216 <div class="section">
217 <h2><a name="Deploy_via_WAR_file_or_web_application_directory"></a>Deploy via WAR file or web application directory?</h2>
218 <p>A web application can be deployed either as a WAR file or a web application directory (aka &#x201c;exploded web application&#x201d;). </p>
219 <p>The advantage of the WAR file is that it is easy to handle because it is just one file.</p>
220 <p>The disadvantage of the WAR file is that it is not easy to change the <a href="digilib-config.html">digilib configuration</a> file or any of the HTML or Javascript files because they are hidden in the WAR file.</p>
221 <p>It is possible to unpack a WAR file into a web application directory to be able to change its contents (see below).</p></div>
222 <div class="section">
223 <h2><a name="Where_to_get_a_WAR_file_or_web_application_directory"></a>Where to get a WAR file or web application directory?</h2>
224 <p>The preferred way is to <a href="build-maven.html">build your own</a> WAR file or web application directory using the digilib sources. In this way you can change the configuration files in the source directory and create a new WAR file or web application directory any time you need. Also you get the chance to always use the latest digilib version by updating the source code. </p>
225 <p>You can also download a digilib WAR file with a default configuration from the <a class="externalLink" href="https://sourceforge.net/projects/digilib/files/">SourceForge 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>. The default configuration will only show a set of sample images. If you want to show your own images you will need to change the <a href="digilib-config.html">digilib configuration</a> to point to your image directories. </p></div>
209 <div class="section"> 226 <div class="section">
210 <h2><a name="Install_a_digilib_WAR_file"></a>Install a digilib WAR file</h2> 227 <h2><a name="Install_a_digilib_WAR_file"></a>Install a digilib WAR file</h2>
211 228
212 <ol style="list-style-type: decimal"> 229 <ol style="list-style-type: decimal">
213 230
214 <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> 231 <li>Get a digilib WAR file.</li>
215 232
216 <li>Rename the WAR file to <tt>digilib.war</tt>.</li> 233 <li>Rename the WAR file to <tt>digilib.war</tt>.</li>
217 234
218 <li>Deploy the WAR file, i.e. drop it into the <tt>webapps</tt> directory of your Servlet Container.</li> 235 <li>Deploy the WAR file by copying it into the <tt>webapps</tt> directory of your Servlet Container.</li>
219 236
220 <li>Restart your Servlet Container (this may not be necessary).</li> 237 <li>Restart your Servlet Container (this may not be necessary).</li>
221 238
222 <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a>.</li> 239 <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a>.</li>
223 </ol> 240 </ol>
224 <p>You will now be able to see the sample images provided with the digilib installation.</p> 241 <p>You will now be able to see the sample images provided with the digilib installation in the default configuration yor your own images if you have updated the <a href="digilib-config.html">configuration</a>.</p>
225 <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> 242 <p>In digilib you can view images 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>ruler.jpg</tt> and it is in the base directory you can now access the URL</p>
243 <p><a class="externalLink" href="http://localhost:8080/digilib/digilib.html?fn=ruler">http://localhost:8080/digilib/digilib.html?fn=ruler</a></p>
244 <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div>
226 <div class="section"> 245 <div class="section">
227 <h2><a name="Install_digilib_as_a_web_application_directory"></a>Install digilib as a web application directory</h2> 246 <h2><a name="Install_digilib_as_a_web_application_directory"></a>Install digilib as a web application directory</h2>
228 <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>
229 <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>
230 <p>Alternatively you can build your own version of digilib as documented <a href="build-maven.html">here</a>.</p>
231 <p>Then:</p>
232 247
233 <ol style="list-style-type: decimal"> 248 <ol style="list-style-type: decimal">
234 249
235 <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> 250 <li>Get a digilib web application directory.</li>
236 251
237 <li>Copy your <tt>digilib</tt> directory into the <tt>webapps</tt> directory of the Servlet Container.</li> 252 <li>Rename the WAR file to <tt>digilib.war</tt>.</li>
238 253
239 <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> 254 <li>Deploy the WAR file by copying it into the <tt>webapps</tt> directory of your Servlet Container.</li>
240 255
241 <li>Start your Servlet Container.</li> 256 <li>Restart your Servlet Container (this may not be necessary).</li>
242 257
243 <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a></li> 258 <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a></li>
244 </ol> 259 </ol>
245 <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> 260 <p>You will now be able to see the sample images provided with the digilib installation in the default configuration yor your own images if you have updated the <a href="digilib-config.html">configuration</a>.</p>
246 <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> 261 <p>In digilib you can view images 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>ruler.jpg</tt> and it is in the base directory you can now access the URL</p>
262 <p><a class="externalLink" href="http://localhost:8080/digilib/digilib.html?fn=ruler">http://localhost:8080/digilib/digilib.html?fn=ruler</a></p>
247 <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div> 263 <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div>
264 <div class="section">
265 <h2><a name="Unpack_a_WAR_file_into_a_web_application_directory"></a>Unpack a WAR file into a web application directory</h2>
266 <p>You can unpack the WAR file into a directory called <tt>digilib</tt> using an unzip tool or the <tt>jar -xf</tt> Java command. </p>
267 <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>. Then:</p>
268
269 <ol style="list-style-type: decimal">
270
271 <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>
272
273 <li>Copy your <tt>digilib</tt> directory into the <tt>webapps</tt> directory of the Servlet Container.</li>
274 </ol></div>
248 </div> 275 </div>
249 </div> 276 </div>
250 </div> 277 </div>
251 278
252 <hr/> 279 <hr/>
253 280
254 <footer> 281 <footer>
255 <div class="container-fluid"> 282 <div class="container-fluid">
256 <div class="row span12">Copyright &copy; 2001-2017 283 <div class="row span12">Copyright &copy; 2001-2017
257 <a href="https://github.com/robcast/digilib">digilib Community</a>. 284 <a href="https://robcast.github.io/digilib/">digilib Community</a>.
258 All Rights Reserved. 285 All Rights Reserved.
259 286
260 </div> 287 </div>
261 288
262 289