Mercurial > hg > digilib

comparison build-maven.html @ 1640:1ae8b89d3a86

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 Tue, 22 Aug 2017 16:38:19 +0000
parents
children 16be3440305b
comparison
equal deleted inserted replaced
-1:000000000000 1640:1ae8b89d3a86
1 <!DOCTYPE html>
2 <!--
3 | Generated by Apache Maven Doxia at 2017-08-22
4 | Rendered using Apache Maven Fluido Skin 1.3.0
5 -->
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20170822" />
11 <meta http-equiv="Content-Language" content="en" />
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" />
14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" />
16
17
18 <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
19
20
21 </head>
22 <body class="topBarDisabled">
23
24
25
26 <div class="container-fluid">
27 <div id="banner">
28 <div class="pull-left">
29 <a href="./" id="bannerLeft">
30 <h2>digilib - a versatile image viewing environment for the internet</h2>
31 </a>
32 </div>
33 <div class="pull-right"> <a href="./" id="bannerRight">
34 <img src="images/digilib-logo-small.png" />
35 </a>
36 </div>
37 <div class="clear"><hr/></div>
38 </div>
39
40 <div id="breadcrumbs">
41 <ul class="breadcrumb">
42
43
44 <li id="publishDate">Last Published: 2017-08-22</li>
45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>
46
47
48
49
50 </ul>
51 </div>
52
53
54 <div class="row-fluid">
55 <div id="leftColumn" class="span3">
56 <div class="well sidebar-nav">
57
58
59 <ul class="nav nav-list">
60 <li class="nav-header">Overview</li>
61
62 <li>
63
64 <a href="index.html" title="About digilib">
65 <i class="none"></i>
66 About digilib</a>
67 </li>
68
69 <li>
70
71 <a href="features.html" title="digilib features">
72 <i class="none"></i>
73 digilib features</a>
74 </li>
75
76 <li>
77
78 <a href="digilib-short.html" title="How digilib works">
79 <i class="none"></i>
80 How digilib works</a>
81 </li>
82
83 <li>
84
85 <a href="history.html" title="Ancient history">
86 <i class="none"></i>
87 Ancient history</a>
88 </li>
89 <li class="nav-header">Installation</li>
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">
99
100 <a href="#"><i class="none"></i>Building digilib</a>
101 </li>
102 <li class="nav-header">Configuration</li>
103
104 <li>
105
106 <a href="digilib-config.html" title="Configuring digilib">
107 <i class="none"></i>
108 Configuring digilib</a>
109 </li>
110
111 <li>
112
113 <a href="image-directories.html" title="Directory layout">
114 <i class="none"></i>
115 Directory layout</a>
116 </li>
117
118 <li>
119
120 <a href="java-settings.html" title="Java settings and tuning">
121 <i class="none"></i>
122 Java settings and tuning</a>
123 </li>
124
125 <li>
126
127 <a href="auth.html" title="Access control">
128 <i class="none"></i>
129 Access control</a>
130 </li>
131 <li class="nav-header">Development</li>
132
133 <li>
134
135 <a href="scaler-api.html" title="The digilib Scaler API">
136 <i class="none"></i>
137 The digilib Scaler API</a>
138 </li>
139
140 <li>
141
142 <a href="iiif-api.html" title="The digilib IIIF API">
143 <i class="none"></i>
144 The digilib IIIF API</a>
145 </li>
146
147 <li>
148
149 <a href="client-integration.html" title="Integrating digilib into your page">
150 <i class="none"></i>
151 Integrating digilib into your page</a>
152 </li>
153
154 <li>
155
156 <a href="plugins.html" title="Digilib plugins">
157 <i class="none"></i>
158 Digilib plugins</a>
159 </li>
160 <li class="nav-header">Project Documentation</li>
161
162 <li>
163
164 <a href="project-info.html" title="Project Information">
165 <i class="icon-chevron-right"></i>
166 Project Information</a>
167 </li>
168 </ul>
169
170
171
172 <hr class="divider" />
173
174 <div id="poweredBy">
175 <div class="clear"></div>
176 <div class="clear"></div>
177 <div class="clear"></div>
178 <a href="http://maven.apache.org/" title="Built by Maven" class="builtBy">
179 <img class="builtBy" alt="Built by Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
180 </a>
181 <a href="http://www.sourceforge.net/" title="Hosted by SourceForge" class="builtBy">
182 <img class="builtBy" alt="Hosted by SourceForge" src="http://upload.wikimedia.org/wikipedia/commons/0/0b/Sourceforge_logo.png" />
183 </a>
184 </div>
185 </div>
186 </div>
187
188
189 <div id="bodyColumn" class="span9" >
190
191 <h1>Building digilib with Maven</h1>
192 <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>
193 <div class="section">
194 <h2><a name="What_you_need"></a>What you need</h2>
195
196 <ul>
197
198 <li><a class="externalLink" href="http://www.java.com/">Java</a> (1.5 or higher)</li>
199
200 <li><a class="externalLink" href="http://maven.apache.org/">Maven</a></li>
201
202 <li><a class="externalLink" href="http://mercurial.selenic.com/">Mercurial</a></li>
203
204 <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>
205 </ul></div>
206 <div class="section">
207 <h2><a name="Quick_build"></a>Quick build</h2>
208 <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>
209
210 <div class="source">
211 <div class="source">
212 <pre>mvn scm:bootstrap -N
213 </pre></div></div>
214 <p>in the same directory as the <tt>pom.xml</tt> file.</p>
215 <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>
216 <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>
217 <div class="section">
218 <h2><a name="Developer_build"></a>Developer build</h2>
219 <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>
220 <p>To check out the latest source code into the directory <tt>digilib</tt> run</p>
221
222 <div class="source">
223 <div class="source">
224 <pre>hg clone http://hg.code.sf.net/p/digilib/code digilib
225 </pre></div></div>
226 <p>The digilib configuration files are now in <tt>digilib/webapp/src/main/webapp/WEB-INF/</tt></p>
227 <p>If you want to update your copy of digilib to the latest version at some time in the future just run</p>
228
229 <div class="source">
230 <div class="source">
231 <pre>hg pull
232 hg up
233 </pre></div></div>
234 <p>in the <tt>digilib</tt> directory.</p>
235 <p>To build the resulting source code, change into the <tt>digilib</tt> directory you checked out above and run</p>
236
237 <div class="source">
238 <div class="source">
239 <pre>mvn package
240 </pre></div></div>
241 <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>
242 <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>
243 <div class="section">
244 <h2><a name="Deploying_the_web_application_by_hand"></a>Deploying the web application by hand</h2>
245 <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>
246 <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>
247 <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>
248 <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>
249 <div class="section">
250 <h2><a name="Configuring_digilib"></a>Configuring digilib</h2>
251 <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>
252 <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>
253 </div>
254 </div>
255 </div>
256
257 <hr/>
258
259 <footer>
260 <div class="container-fluid">
261 <div class="row span12">Copyright &copy; 2001-2017
262 <a href="http://digilib.sourceforge.net">digilib Community</a>.
263 All Rights Reserved.
264
265 </div>
266
267
268
269 </div>
270 </footer>
271 </body>
272 </html>