digilib - The Digital Image Library

diff -r 636e7342b1b6 -r fe8300fdcd9d build-maven.html --- 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 @@ - + digilib - The Digital Image Library – Building digilib with Maven @@ -41,7 +41,7 @@

Last Published: 2017-08-22
Last Published: 2017-11-20
|
Version: 2.5-SNAPSHOT
Installation
+ + Building digilib +
@@ -95,10 +100,12 @@ Installing digilib
+
- Building digilib -

+ + Server setups

Configuration
@@ -178,7 +185,7 @@ - + @@ -192,31 +199,48 @@

Building digilib with Maven
-
The easiest way to get the latest and greatest digilib is the Maven build tool. It will download, compile, and install the latest digilib version and all required libraries.
+
The best way to get the latest and greatest digilib is using the git version control and the Maven build tool. Git will download the digilib code and Maven will compile, and install the latest digilib version and all required libraries.

What you need

-
Java (1.5 or higher)
+
git
+ +
Java JDK (7 or higher)

Maven
- -
Mercurial
- -
A Servlet container like Tomcat or Jetty to run the web application.

-
Quick build
-
The fastest way to build the digilib web application is to download the digilib project file pom.xml (download and save it) and run
+
Quick developer build and run
+
+ +
+
Clone the digilib repository into a directory digilib
+

-
mvn scm:bootstrap -N -
-
in the same directory as the pom.xml file.
-
This will create a web application directory digilib-webapp-2.2-SNAPSHOT and a WAR file digilib-webapp-2.2-SNAPSHOT-srv3.war (or similar) in the subdirectory target/checkout/webapp/target/
-
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 -Pservlet2 to the Maven command line above.
+
git clone https://github.com/robcast/digilib.git +

+ +

Change to the directory

+ +

cd digilib
+

+ +

build and run the webapp in the embedded Jetty runtime for development

+ +

mvn jetty:run-exploded --projects webapp
+

+ +

and watch your digilib at http://localhost:8080/digilib.html

Developer build

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.

@@ -224,35 +248,44 @@

hg clone http://hg.code.sf.net/p/digilib/code digilib
+git clone https://github.com/robcast/digilib.git

The digilib configuration files are now in digilib/webapp/src/main/webapp/WEB-INF/

and change into the repository directory

+ +

cd digilib
+

If you want to update your copy of digilib to the latest version at some time in the future just run

hg pull
-hg up
+git pull

in the digilib directory.

To build the resulting source code, change into the digilib directory you checked out above and run

The digilib configuration files are in the sub-directory webapp/src/main/webapp/WEB-INF/ (see below).

To build the resulting source code run

mvn package

This will create a web application directory digilib-webapp-2.2-SNAPSHOT and a WAR file digilib-webapp-2.2-SNAPSHOT-srv3.war (or similar) in the subdirectory webapp/target/ .

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 -Pservlet2 to the Maven command line above.

This will create a web application directory digilib-webapp-2.5-SNAPSHOT and a WAR file digilib-webapp-2.5-SNAPSHOT-srv3.war (or similar) in the subdirectory webapp/target/ .

Deploying the web application by hand

To deploy digilib just copy the web application directory or the WAR file into the webapp directory of the Servlet container.

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 please rename the web application directory or WAR file to digitallibrary before you start

Then you should see your digilib running at the URL http://localhost:8080/digitallibrary/jquery/digilib.html

If you use the unmodified default configuration you should see the digilib logo and other sample images from the sample-images directory of the web application.

Then you should see digilib running at the URL http://localhost:8080/digilib/digilib.html

If you use the unmodified default configuration you should see the digilib logo and other sample images from the sample-images directory of the web application.

For more detailed documentation see the deployment instructions.

Configuring digilib

To change the configuration of digilib just edit the file digilib-config.xml in the web application directory (digitallibrary/WEB-INF/digilib-config.xml). Documentation of the configuration options is here.

You can see a summary of your running digilib configuration at the URL http://localhost:8080/digitallibrary/server/dlConfig.jsp

To change the configuration of digilib just create and edit the file digilib-config.xml in the web application WEB-INF directory (webapp/src/main/webapp/WEB-INF/digilib-config.xml). You can copy and rename the sample file digilib-config.xml.template to get some default options to start with. Please check the documentation of the configuration options.

You can see a summary of your running digilib configuration at the URL http://localhost:8080/digilib/server/dlConfig.jsp

Additional Maven build options

servlet2

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 -Pservlet2 to the Maven command line above.

@@ -262,7 +295,7 @@