Mercurial > hg > digilib

comparison install-digilib.html @ 1666:1beeb9319d78

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, 21 Nov 2017 19:34:58 +0000
parents fe8300fdcd9d
children 8a9c66abb57c
comparison
equal deleted inserted replaced
1659:fe8300fdcd9d 1666:1beeb9319d78
1 <!DOCTYPE html> 1 <!DOCTYPE html>
2 <!-- 2 <!--
3 | Generated by Apache Maven Doxia at 2017-11-20 3 | Generated by Apache Maven Doxia at 2017-11-21
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="20171120" /> 10 <meta name="Date-Revision-yyyymmdd" content="20171121" />
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-11-20</li> 44 <li id="publishDate">Last Published: 2017-11-21</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
209 209
210 <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>
211 </ul> 211 </ul>
212 <div class="section"> 212 <div class="section">
213 <h2><a name="Start_the_Servlet_Container"></a>Start the Servlet Container</h2> 213 <h2><a name="Start_the_Servlet_Container"></a>Start the Servlet Container</h2>
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> 214 <p>Install and run the Servlet Container of your choice: <a class="externalLink" href="http://tomcat.apache.org/">Tomcat</a> or <a class="externalLink" href="http://wiki.eclipse.org/Jetty/">Jetty</a>.</p>
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> 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"> 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> 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> 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> 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> 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> 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"> 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> 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> 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> 225 <p>You can also download a digilib WAR file with a default configuration from the <a class="externalLink" href="https://github.com/robcast/digilib/releases">GitHub release 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>
226 <div class="section"> 226 <div class="section">
227 <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>
228 228
229 <ol style="list-style-type: decimal"> 229 <ol style="list-style-type: decimal">
230 230
231 <li>Get a digilib WAR file.</li> 231 <li>Get a digilib WAR file.</li>
232 232
233 <li>Rename the WAR file to <tt>digilib.war</tt>.</li> 233 <li>Rename the WAR file to <tt>digilib.war</tt>.</li>
234 234
235 <li>Deploy the WAR file by copying 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>
236 236
237 <li>Restart your Servlet Container (this may not be necessary).</li> 237 <li>Restart your Servlet Container (this may not be necessary).</li>
238 238
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> 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>
240 </ol> 240 </ol>
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> 241 <p>You will now be able to see the sample images provided with the digilib installation in the default configuration or your own images if you have updated the <a href="digilib-config.html">configuration</a>.</p>
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> 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> 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> 244 <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div>
245 <div class="section"> 245 <div class="section">
246 <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>
247 247
248 <ol style="list-style-type: decimal"> 248 <ol style="list-style-type: decimal">
249 249
250 <li>Get a digilib web application directory.</li> 250 <li>Get a digilib web application directory.</li>
251 251
252 <li>Rename the WAR file to <tt>digilib.war</tt>.</li> 252 <li>Rename the directory to <tt>digilib</tt>.</li>
253 253
254 <li>Deploy the WAR file by copying it into the <tt>webapps</tt> directory of your Servlet Container.</li> 254 <li>Deploy the directory by copying it into the <tt>webapps</tt> directory of your Servlet Container.</li>
255 255
256 <li>Restart your Servlet Container (this may not be necessary).</li> 256 <li>Restart your Servlet Container (this may not be necessary).</li>
257 257
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> 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>
259 </ol> 259 </ol>
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> 260 <p>You will now be able to see the sample images provided with the digilib installation in the default configuration or your own images if you have updated the <a href="digilib-config.html">configuration</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> 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> 262 <p><a class="externalLink" href="http://localhost:8080/digilib/digilib.html?fn=ruler">http://localhost:8080/digilib/digilib.html?fn=ruler</a></p>
263 <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"> 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> 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> 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> 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 268
269 <ol style="list-style-type: decimal"> 269 <ol style="list-style-type: decimal">
270 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> 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 272
273 <li>Copy your <tt>digilib</tt> directory into the <tt>webapps</tt> directory of the Servlet Container.</li> 273 <li>Keep the <tt>digilib</tt> directory in the <tt>webapps</tt> directory of the Servlet Container.</li>
274 </ol></div> 274 </ol></div>
275 </div> 275 </div>
276 </div> 276 </div>
277 </div> 277 </div>
278 278