Mercurial > hg > digilib
view install-digilib.html @ 1682:8a9c66abb57c
Creating site for 2.5-SNAPSHOT
| author | Robert Casties <casties@mpiwg-berlin.mpg.de> |
|---|---|
| date | Wed, 14 Mar 2018 18:57:23 +0000 |
| parents | 1beeb9319d78 |
| children | 79c837179ffb |
line wrap: on
line source
<!DOCTYPE html> <!-- | Generated by Apache Maven Doxia at 2018-03-14 | Rendered using Apache Maven Fluido Skin 1.3.0 --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="Date-Revision-yyyymmdd" content="20180314" /> <meta http-equiv="Content-Language" content="en" /> <title>digilib - The Digital Image Library – Installing digilib</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script> </head> <body class="topBarDisabled"> <div class="container-fluid"> <div id="banner"> <div class="pull-left"> <a href="https://robcast.github.io/digilib/" id="bannerLeft"> <h2>digilib - a versatile image viewing environment for the internet</h2> </a> </div> <div class="pull-right"> <a href="https://robcast.github.io/digilib/" id="bannerRight"> <img src="images/digilib-logo-small.png" /> </a> </div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> <li id="publishDate">Last Published: 2018-03-14</li> <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li> </ul> </div> <div class="row-fluid"> <div id="leftColumn" class="span3"> <div class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">Overview</li> <li> <a href="index.html" title="About digilib"> <i class="none"></i> About digilib</a> </li> <li> <a href="features.html" title="digilib features"> <i class="none"></i> digilib features</a> </li> <li> <a href="digilib-short.html" title="How digilib works"> <i class="none"></i> How digilib works</a> </li> <li> <a href="history.html" title="Ancient history"> <i class="none"></i> Ancient history</a> </li> <li class="nav-header">Installation</li> <li> <a href="build-maven.html" title="Building digilib"> <i class="none"></i> Building digilib</a> </li> <li class="active"> <a href="#"><i class="none"></i>Installing digilib</a> </li> <li> <a href="server-setup.html" title="Server setup"> <i class="none"></i> Server setup</a> </li> <li class="nav-header">Configuration</li> <li> <a href="digilib-config.html" title="Configuring digilib"> <i class="none"></i> Configuring digilib</a> </li> <li> <a href="image-directories.html" title="Directory layout"> <i class="none"></i> Directory layout</a> </li> <li> <a href="java-settings.html" title="Java settings and tuning"> <i class="none"></i> Java settings and tuning</a> </li> <li> <a href="auth.html" title="Access control"> <i class="none"></i> Access control</a> </li> <li class="nav-header">Development</li> <li> <a href="scaler-api.html" title="The digilib Scaler API"> <i class="none"></i> The digilib Scaler API</a> </li> <li> <a href="iiif-api.html" title="The digilib IIIF API"> <i class="none"></i> The digilib IIIF API</a> </li> <li> <a href="client-integration.html" title="Integrating digilib into your page"> <i class="none"></i> Integrating digilib into your page</a> </li> <li> <a href="plugins.html" title="Digilib plugins"> <i class="none"></i> Digilib plugins</a> </li> <li class="nav-header">Project Documentation</li> <li> <a href="project-info.html" title="Project Information"> <i class="icon-chevron-right"></i> Project Information</a> </li> </ul> <hr class="divider" /> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> <div class="clear"></div> <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy"> <img class="builtBy" alt="Built by Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> </a> <a href="../../" title="Hosted by GitHub" class="builtBy"> <img class="builtBy" alt="Hosted by GitHub" src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Logo.png" width="200px" /> </a> <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy"> <img class="builtBy" alt="Hosted by SourceForge" src="https://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" /> </a> </div> </div> </div> <div id="bodyColumn" class="span9" > <h1>Installing digilib</h1> <p>To run digilib you need:</p> <ul> <li><a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java JDK</a> (7 or higher)</li> <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> <li>the digilib web application as a WAR file or application directory</li> </ul> <div class="section"> <h2><a name="Start_the_Servlet_Container"></a>Start the Servlet Container</h2> <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> <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> <div class="section"> <h2><a name="Deploy_via_WAR_file_or_web_application_directory"></a>Deploy via WAR file or web application directory?</h2> <p>A web application can be deployed either as a WAR file or a web application directory (aka “exploded web application”). </p> <p>The advantage of the WAR file is that it is easy to handle because it is just one file.</p> <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> <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> <div class="section"> <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> <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> <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> <div class="section"> <h2><a name="Install_a_digilib_WAR_file"></a>Install a digilib WAR file</h2> <ol style="list-style-type: decimal"> <li>Get a digilib WAR file.</li> <li>Rename the WAR file to <tt>digilib.war</tt>.</li> <li>Deploy the WAR file by copying it into the <tt>webapps</tt> directory of your Servlet Container.</li> <li>Restart your Servlet Container (this may not be necessary).</li> <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a>.</li> </ol> <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> <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> <p><a class="externalLink" href="http://localhost:8080/digilib/digilib.html?fn=ruler">http://localhost:8080/digilib/digilib.html?fn=ruler</a></p> <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div> <div class="section"> <h2><a name="Install_digilib_as_a_web_application_directory"></a>Install digilib as a web application directory</h2> <ol style="list-style-type: decimal"> <li>Get a digilib web application directory.</li> <li>Rename the directory to <tt>digilib</tt>.</li> <li>Deploy the directory by copying it into the <tt>webapps</tt> directory of your Servlet Container.</li> <li>Restart your Servlet Container (this may not be necessary).</li> <li>Access your digilib instance at <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a></li> </ol> <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> <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> <p><a class="externalLink" href="http://localhost:8080/digilib/digilib.html?fn=ruler">http://localhost:8080/digilib/digilib.html?fn=ruler</a></p> <p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div> <div class="section"> <h2><a name="Unpack_a_WAR_file_into_a_web_application_directory"></a>Unpack a WAR file into a web application directory</h2> <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> <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> <ol style="list-style-type: decimal"> <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> <li>Keep the <tt>digilib</tt> directory in the <tt>webapps</tt> directory of the Servlet Container.</li> </ol></div> </div> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row span12">Copyright © 2001-2018 <a href="https://robcast.github.io/digilib/">digilib Community</a>. All Rights Reserved. </div> </div> </footer> </body> </html>