Mercurial > hg > digilib

comparison build-maven.html @ 1659:fe8300fdcd9d

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 Mon, 20 Nov 2017 20:24:00 +0000
parents 636e7342b1b6
children 1beeb9319d78
comparison
equal deleted inserted replaced
1642:636e7342b1b6 1659:fe8300fdcd9d
1 <!DOCTYPE html> 1 <!DOCTYPE html>
2 <!-- 2 <!--
3 | Generated by Apache Maven Doxia at 2017-08-22 3 | Generated by Apache Maven Doxia at 2017-11-20
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="20170822" /> 10 <meta name="Date-Revision-yyyymmdd" content="20171120" />
11 <meta http-equiv="Content-Language" content="en" /> 11 <meta http-equiv="Content-Language" content="en" />
12 <title>digilib - The Digital Image Library &#x2013; Building digilib with Maven</title> 12 <title>digilib - The Digital Image Library &#x2013; Building digilib with Maven</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-08-22</li> 44 <li id="publishDate">Last Published: 2017-11-20</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
86 <i class="none"></i> 86 <i class="none"></i>
87 Ancient history</a> 87 Ancient history</a>
88 </li> 88 </li>
89 <li class="nav-header">Installation</li> 89 <li class="nav-header">Installation</li>
90 90
91 <li>
92
93 <a href="install-digilib.html" title="Installing digilib">
94 <i class="none"></i>
95 Installing digilib</a>
96 </li>
97
98 <li class="active"> 91 <li class="active">
99 92
100 <a href="#"><i class="none"></i>Building digilib</a> 93 <a href="#"><i class="none"></i>Building digilib</a>
101 </li> 94 </li>
95
96 <li>
97
98 <a href="install-digilib.html" title="Installing digilib">
99 <i class="none"></i>
100 Installing digilib</a>
101 </li>
102
103 <li>
104
105 <a href="server-setups.html" title="Server setups">
106 <i class="none"></i>
107 Server setups</a>
108 </li>
102 <li class="nav-header">Configuration</li> 109 <li class="nav-header">Configuration</li>
103 110
104 <li> 111 <li>
105 112
106 <a href="digilib-config.html" title="Configuring digilib"> 113 <a href="digilib-config.html" title="Configuring digilib">
176 <div class="clear"></div> 183 <div class="clear"></div>
177 <div class="clear"></div> 184 <div class="clear"></div>
178 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy"> 185 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy">
179 <img class="builtBy" alt="Built by Maven" src="https://maven.apache.org/images/logos/maven-feather.png" /> 186 <img class="builtBy" alt="Built by Maven" src="https://maven.apache.org/images/logos/maven-feather.png" />
180 </a> 187 </a>
181 <a href="https://github.com/" title="Hosted by GitHub" class="builtBy"> 188 <a href="../../" title="Hosted by GitHub" class="builtBy">
182 <img class="builtBy" alt="Hosted by GitHub" src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Logo.png" width="200px" /> 189 <img class="builtBy" alt="Hosted by GitHub" src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Logo.png" width="200px" />
183 </a> 190 </a>
184 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy"> 191 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy">
185 <img class="builtBy" alt="Hosted by SourceForge" src="https://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" /> 192 <img class="builtBy" alt="Hosted by SourceForge" src="https://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" />
186 </a> 193 </a>
190 197
191 198
192 <div id="bodyColumn" class="span9" > 199 <div id="bodyColumn" class="span9" >
193 200
194 <h1>Building digilib with Maven</h1> 201 <h1>Building digilib with Maven</h1>
195 <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> 202 <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>
196 <div class="section"> 203 <div class="section">
197 <h2><a name="What_you_need"></a>What you need</h2> 204 <h2><a name="What_you_need"></a>What you need</h2>
198 205
199 <ul> 206 <ul>
200 207
201 <li><a class="externalLink" href="http://www.java.com/">Java</a> (1.5 or higher)</li> 208 <li><a class="externalLink" href="https://git-scm.com/">git</a></li>
209
210 <li><a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java JDK</a> (7 or higher)</li>
202 211
203 <li><a class="externalLink" href="http://maven.apache.org/">Maven</a></li> 212 <li><a class="externalLink" href="http://maven.apache.org/">Maven</a></li>
204
205 <li><a class="externalLink" href="http://mercurial.selenic.com/">Mercurial</a></li>
206
207 <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>
208 </ul></div> 213 </ul></div>
209 <div class="section"> 214 <div class="section">
210 <h2><a name="Quick_build"></a>Quick build</h2> 215 <h2><a name="Quick_developer_build_and_run"></a>Quick developer build and run</h2>
211 <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> 216
212 217 <ol style="list-style-type: decimal">
213 <div class="source"> 218
214 <div class="source"> 219 <li>
215 <pre>mvn scm:bootstrap -N 220 <p>Clone the digilib repository into a directory <tt>digilib</tt></p>
216 </pre></div></div> 221
217 <p>in the same directory as the <tt>pom.xml</tt> file.</p> 222 <div class="source">
218 <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> 223 <div class="source">
219 <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> 224 <pre>git clone https://github.com/robcast/digilib.git
225 </pre></div></div></li>
226
227 <li>
228 <p>Change to the directory</p>
229
230 <div class="source">
231 <div class="source">
232 <pre>cd digilib
233 </pre></div></div></li>
234
235 <li>
236 <p>build and run the webapp in the embedded Jetty runtime for development</p>
237
238 <div class="source">
239 <div class="source">
240 <pre>mvn jetty:run-exploded --projects webapp
241 </pre></div></div></li>
242 </ol>
243 <p>and watch your digilib at <a class="externalLink" href="http://localhost:8080/digilib.html">http://localhost:8080/digilib.html</a></p></div>
220 <div class="section"> 244 <div class="section">
221 <h2><a name="Developer_build"></a>Developer build</h2> 245 <h2><a name="Developer_build"></a>Developer build</h2>
222 <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> 246 <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>
223 <p>To check out the latest source code into the directory <tt>digilib</tt> run</p> 247 <p>To check out the latest source code into the directory <tt>digilib</tt> run</p>
224 248
225 <div class="source"> 249 <div class="source">
226 <div class="source"> 250 <div class="source">
227 <pre>hg clone http://hg.code.sf.net/p/digilib/code digilib 251 <pre>git clone https://github.com/robcast/digilib.git
228 </pre></div></div> 252 </pre></div></div>
229 <p>The digilib configuration files are now in <tt>digilib/webapp/src/main/webapp/WEB-INF/</tt></p> 253 <p>and change into the repository directory</p>
254
255 <div class="source">
256 <div class="source">
257 <pre>cd digilib
258 </pre></div></div>
230 <p>If you want to update your copy of digilib to the latest version at some time in the future just run</p> 259 <p>If you want to update your copy of digilib to the latest version at some time in the future just run</p>
231 260
232 <div class="source"> 261 <div class="source">
233 <div class="source"> 262 <div class="source">
234 <pre>hg pull 263 <pre>git pull
235 hg up
236 </pre></div></div> 264 </pre></div></div>
237 <p>in the <tt>digilib</tt> directory.</p> 265 <p>The digilib configuration files are in the sub-directory <tt>webapp/src/main/webapp/WEB-INF/</tt> (see below).</p>
238 <p>To build the resulting source code, change into the <tt>digilib</tt> directory you checked out above and run</p> 266 <p>To build the resulting source code run</p>
239 267
240 <div class="source"> 268 <div class="source">
241 <div class="source"> 269 <div class="source">
242 <pre>mvn package 270 <pre>mvn package
243 </pre></div></div> 271 </pre></div></div>
244 <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> 272 <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>
245 <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>
246 <div class="section"> 273 <div class="section">
247 <h2><a name="Deploying_the_web_application_by_hand"></a>Deploying the web application by hand</h2> 274 <h2><a name="Deploying_the_web_application_by_hand"></a>Deploying the web application by hand</h2>
248 <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> 275 <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>
249 <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> 276 <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>
250 <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> 277 <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>
251 <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> 278 <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>
279 <p>For more detailed documentation see the <a href="install-digilib.html">deployment instructions</a>.</p></div>
252 <div class="section"> 280 <div class="section">
253 <h2><a name="Configuring_digilib"></a>Configuring digilib</h2> 281 <h2><a name="Configuring_digilib"></a>Configuring digilib</h2>
254 <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> 282 <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>
255 <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> 283 <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>
284 <div class="section">
285 <h2><a name="Additional_Maven_build_options"></a>Additional Maven build options</h2>
286 <div class="section">
287 <h3><a name="servlet2"></a>servlet2</h3>
288 <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>
256 </div> 289 </div>
257 </div> 290 </div>
258 </div> 291 </div>
259 292
260 <hr/> 293 <hr/>
261 294
262 <footer> 295 <footer>
263 <div class="container-fluid"> 296 <div class="container-fluid">
264 <div class="row span12">Copyright &copy; 2001-2017 297 <div class="row span12">Copyright &copy; 2001-2017
265 <a href="https://github.com/robcast/digilib">digilib Community</a>. 298 <a href="https://robcast.github.io/digilib/">digilib Community</a>.
266 All Rights Reserved. 299 All Rights Reserved.
267 300
268 </div> 301 </div>
269 302
270 303