Mercurial > hg > digilib
diff build-maven.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/build-maven.html Tue Aug 22 18:46:51 2017 +0000 +++ b/build-maven.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 – Building digilib with Maven</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,11 @@ </li> <li class="nav-header">Installation</li> + <li class="active"> + + <a href="#"><i class="none"></i>Building digilib</a> + </li> + <li> <a href="install-digilib.html" title="Installing digilib"> @@ -95,10 +100,12 @@ Installing digilib</a> </li> - <li class="active"> + <li> - <a href="#"><i class="none"></i>Building digilib</a> - </li> + <a href="server-setups.html" title="Server setups"> + <i class="none"></i> + Server setups</a> + </li> <li class="nav-header">Configuration</li> <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"> @@ -192,31 +199,48 @@ <div id="bodyColumn" class="span9" > <h1>Building digilib with Maven</h1> -<p>The easiest way to get the latest and greatest digilib is the <a class="externalLink" href="http://maven.apache.org/">Maven</a> build tool. It will download, compile, and install the latest digilib version and all required libraries.</p> +<p>The best way to get the latest and greatest digilib is using the <a class="externalLink" href="https://git-scm.com/">git</a> version control and the <a class="externalLink" href="http://maven.apache.org/">Maven</a> build tool. Git will download the digilib code and Maven will compile, and install the latest digilib version and all required libraries.</p> <div class="section"> <h2><a name="What_you_need"></a>What you need</h2> <ul> -<li><a class="externalLink" href="http://www.java.com/">Java</a> (1.5 or higher)</li> +<li><a class="externalLink" href="https://git-scm.com/">git</a></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 class="externalLink" href="http://maven.apache.org/">Maven</a></li> - -<li><a class="externalLink" href="http://mercurial.selenic.com/">Mercurial</a></li> - -<li>A Servlet container like <a class="externalLink" href="http://tomcat.apache.org/">Tomcat</a> or <a class="externalLink" href="http://www.eclipse.org/jetty/">Jetty</a> to run the web application.</li> </ul></div> <div class="section"> -<h2><a name="Quick_build"></a>Quick build</h2> -<p>The fastest way to build the digilib web application is to download the digilib project file <a class="externalLink" href="https://sourceforge.net/p/digilib/code/ci/default/tree/pom.xml?format=raw">pom.xml</a> (download and save it) and run</p> +<h2><a name="Quick_developer_build_and_run"></a>Quick developer build and run</h2> +<ol style="list-style-type: decimal"> + +<li> +<p>Clone the digilib repository into a directory <tt>digilib</tt></p> + <div class="source"> <div class="source"> -<pre>mvn scm:bootstrap -N -</pre></div></div> -<p>in the same directory as the <tt>pom.xml</tt> file.</p> -<p>This will create a web application directory <tt>digilib-webapp-2.2-SNAPSHOT</tt> and a WAR file <tt>digilib-webapp-2.2-SNAPSHOT-srv3.war</tt> (or similar) in the subdirectory <tt>target/checkout/webapp/target/</tt></p> -<p>Digilib uses the Asynchronous Servlet API (3.0) by default. You will need Java version 6 and Tomcat version 7 or Jetty version 8 or later to use it. If you want to use the old non-Asynchronous Servlet API (2.3) add <tt>-Pservlet2</tt> to the Maven command line above.</p></div> +<pre>git clone https://github.com/robcast/digilib.git +</pre></div></div></li> + +<li> +<p>Change to the directory</p> + +<div class="source"> +<div class="source"> +<pre>cd digilib +</pre></div></div></li> + +<li> +<p>build and run the webapp in the embedded Jetty runtime for development</p> + +<div class="source"> +<div class="source"> +<pre>mvn jetty:run-exploded --projects webapp +</pre></div></div></li> +</ol> +<p>and watch your digilib at <a class="externalLink" href="http://localhost:8080/digilib.html">http://localhost:8080/digilib.html</a></p></div> <div class="section"> <h2><a name="Developer_build"></a>Developer build</h2> <p>If you are developing with digilib it is helpful to check out the source code separately so you can keep it around, modify it or change the configuration before you deploy.</p> @@ -224,35 +248,44 @@ <div class="source"> <div class="source"> -<pre>hg clone http://hg.code.sf.net/p/digilib/code digilib +<pre>git clone https://github.com/robcast/digilib.git </pre></div></div> -<p>The digilib configuration files are now in <tt>digilib/webapp/src/main/webapp/WEB-INF/</tt></p> +<p>and change into the repository directory</p> + +<div class="source"> +<div class="source"> +<pre>cd digilib +</pre></div></div> <p>If you want to update your copy of digilib to the latest version at some time in the future just run</p> <div class="source"> <div class="source"> -<pre>hg pull -hg up +<pre>git pull </pre></div></div> -<p>in the <tt>digilib</tt> directory.</p> -<p>To build the resulting source code, change into the <tt>digilib</tt> directory you checked out above and run</p> +<p>The digilib configuration files are in the sub-directory <tt>webapp/src/main/webapp/WEB-INF/</tt> (see below).</p> +<p>To build the resulting source code run</p> <div class="source"> <div class="source"> <pre>mvn package </pre></div></div> -<p>This will create a web application directory <tt>digilib-webapp-2.2-SNAPSHOT</tt> and a WAR file <tt>digilib-webapp-2.2-SNAPSHOT-srv3.war</tt> (or similar) in the subdirectory <tt>webapp/target/</tt> .</p> -<p>Digilib uses the Asynchronous Servlet API (3.0) by default. You will need Java version 6 and Tomcat version 7 or Jetty version 8 or later to use it. If you want to use the old non-Asynchronous Servlet API (2.3) add <tt>-Pservlet2</tt> to the Maven command line above.</p></div> +<p>This will create a web application directory <tt>digilib-webapp-2.5-SNAPSHOT</tt> and a WAR file <tt>digilib-webapp-2.5-SNAPSHOT-srv3.war</tt> (or similar) in the subdirectory <tt>webapp/target/</tt> .</p></div> <div class="section"> <h2><a name="Deploying_the_web_application_by_hand"></a>Deploying the web application by hand</h2> <p>To deploy digilib just copy the web application directory or the WAR file into the <tt>webapp</tt> directory of the Servlet container.</p> -<p>Since the URL of your digilib server starts with the name of the web application and the name of the web application is derived from the name of the web application directory or the WAR file <b>please rename the web application directory or WAR file to <tt>digitallibrary</tt> before you start</b></p> -<p>Then you should see your digilib running at the URL <a class="externalLink" href="http://localhost:8080/digitallibrary/jquery/digilib.html">http://localhost:8080/digitallibrary/jquery/digilib.html</a></p> -<p>If you use the unmodified default configuration you should see the digilib logo and other sample images from the <tt>sample-images</tt> directory of the web application.</p></div> +<p>Since the URL of your digilib server starts with the name of the web application and the name of the web application is derived from the name of the web application directory or the WAR file <b>please rename the web application directory or WAR file to <tt>digilib</tt> before you start</b></p> +<p>Then you should see digilib running at the URL <a class="externalLink" href="http://localhost:8080/digilib/digilib.html">http://localhost:8080/digilib/digilib.html</a></p> +<p>If you use the unmodified default configuration you should see the digilib logo and other sample images from the <tt>sample-images</tt> directory of the web application.</p> +<p>For more detailed documentation see the <a href="install-digilib.html">deployment instructions</a>.</p></div> <div class="section"> <h2><a name="Configuring_digilib"></a>Configuring digilib</h2> -<p>To change the configuration of digilib just edit the file <tt>digilib-config.xml</tt> in the web application directory (<tt>digitallibrary/WEB-INF/digilib-config.xml</tt>). Documentation of the configuration options is <a href="digilib-config.html">here</a>.</p> -<p>You can see a summary of your running digilib configuration at the URL <a class="externalLink" href="http://localhost:8080/digitallibrary/server/dlConfig.jsp">http://localhost:8080/digitallibrary/server/dlConfig.jsp</a></p></div> +<p>To change the configuration of digilib just create and edit the file <tt>digilib-config.xml</tt> in the web application WEB-INF directory (<tt>webapp/src/main/webapp/WEB-INF/digilib-config.xml</tt>). You can copy and rename the sample file <tt>digilib-config.xml.template</tt> to get some default options to start with. Please check the <a href="digilib-config.html">documentation of the configuration options</a>.</p> +<p>You can see a summary of your running digilib configuration at the URL <a class="externalLink" href="http://localhost:8080/digilib/server/dlConfig.jsp">http://localhost:8080/digilib/server/dlConfig.jsp</a></p></div> +<div class="section"> +<h2><a name="Additional_Maven_build_options"></a>Additional Maven build options</h2> +<div class="section"> +<h3><a name="servlet2"></a>servlet2</h3> +<p>Digilib uses the Asynchronous Servlet API (3.0) by default. You will need Java version 6 or later and Tomcat version 7 or Jetty version 8 or later to use it. If you want to use the old non-Asynchronous Servlet API (2.3) add <tt>-Pservlet2</tt> to the Maven command line above.</p></div></div> </div> </div> </div> @@ -262,7 +295,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>