Mercurial > hg > digilib
diff install-digilib.html @ 1659:fe8300fdcd9d
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 |
line wrap: on
line diff
--- a/install-digilib.html Tue Aug 22 18:46:51 2017 +0000 +++ b/install-digilib.html Mon Nov 20 20:24:00 2017 +0000 @@ -1,13 +1,13 @@ <!DOCTYPE html> <!-- - | Generated by Apache Maven Doxia at 2017-08-22 + | Generated by Apache Maven Doxia at 2017-11-20 | 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 name="Date-Revision-yyyymmdd" content="20171120" /> <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" /> @@ -41,7 +41,7 @@ <ul class="breadcrumb"> - <li id="publishDate">Last Published: 2017-08-22</li> + <li id="publishDate">Last Published: 2017-11-20</li> <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li> @@ -88,6 +88,13 @@ </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> @@ -95,9 +102,9 @@ <li> - <a href="build-maven.html" title="Building digilib"> + <a href="server-setups.html" title="Server setups"> <i class="none"></i> - Building digilib</a> + Server setups</a> </li> <li class="nav-header">Configuration</li> @@ -178,7 +185,7 @@ <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="https://github.com/" title="Hosted by GitHub" class="builtBy"> + <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"> @@ -196,55 +203,75 @@ <ul> -<li><a class="externalLink" href="http://www.java.com/">Java</a> (1.6 or higher)</li> +<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 higher) or <a class="externalLink" href="http://www.eclipse.org/jetty/">Jetty</a> (version 8 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="Run_the_Servlet_Container"></a>Run the Servlet Container</h2> +<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-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> +<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://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> <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>Get a digilib WAR file.</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>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.</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> +<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> +<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> -<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>Get a digilib web application directory.</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 yor 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>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> +</ol></div> </div> </div> </div> @@ -254,7 +281,7 @@ <footer> <div class="container-fluid"> <div class="row span12">Copyright © 2001-2017 - <a href="https://github.com/robcast/digilib">digilib Community</a>. + <a href="https://robcast.github.io/digilib/">digilib Community</a>. All Rights Reserved. </div>