Mercurial > hg > digilib
diff install-digilib.html @ 1640:1ae8b89d3a86
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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/install-digilib.html Tue Aug 22 16:38:19 2017 +0000 @@ -0,0 +1,264 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-08-22 + | 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="20170822" /> + <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="./" id="bannerLeft"> + <h2>digilib - a versatile image viewing environment for the internet</h2> + </a> + </div> + <div class="pull-right"> <a href="./" 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: 2017-08-22</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 class="active"> + + <a href="#"><i class="none"></i>Installing digilib</a> + </li> + + <li> + + <a href="build-maven.html" title="Building digilib"> + <i class="none"></i> + Building digilib</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="http://maven.apache.org/images/logos/maven-feather.png" /> + </a> + <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy"> + <img class="builtBy" alt="Hosted by SourceForge" src="http://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.java.com/">Java</a> (1.6 or higher)</li> + +<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> + +<li>the digilib web application as a WAR file or application directory</li> +</ul> +<div class="section"> +<h2><a name="Run_the_Servlet_Container"></a>Run the Servlet Container</h2> +<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> +<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> +<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>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> + +<li>Rename the WAR file to <tt>digilib.war</tt>.</li> + +<li>Deploy the WAR file, i.e. drop 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.</p> +<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> +<div class="section"> +<h2><a name="Install_digilib_as_a_web_application_directory"></a>Install digilib as a web application directory</h2> +<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> +<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> +<p>Alternatively you can build your own version of digilib as documented <a href="build-maven.html">here</a>.</p> +<p>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>Copy your <tt>digilib</tt> directory into the <tt>webapps</tt> directory of the Servlet Container.</li> + +<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> + +<li>Start your Servlet Container.</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 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> +<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> +<p>Read more about the layout of image files and directories <a href="image-directories.html">here</a>.</p></div> + </div> + </div> + </div> + + <hr/> + + <footer> + <div class="container-fluid"> + <div class="row span12">Copyright © 2001-2017 + <a href="http://digilib.sourceforge.net">digilib Community</a>. + All Rights Reserved. + + </div> + + + + </div> + </footer> + </body> +</html>