README.md

digilib - The Digital Image Library

A versatile image viewing environment for the internet.

What is digilib?

• digilib is a web based client/server technology for images. The image content is processed on-the-fly by a Java Servlet on the server side so that only the visible portion of the image is sent to the web browser on the client side.
• digilib supports a wide range of image formats and viewing options on the server side while only requiring an internet browser with Javascript and a low bandwidth internet connection on the client side.
• digilib enables very detailed work on an image as required by scholars with elaborate viewing features like an option to show images on the screen in their original size.
• digilib facilitates cooperation of scholars over the internet and novel uses of source material by image annotations and stable references that can be embedded in URLs.
• digilib facilitates federation of image servers through a standards compliant IIIF image API.
• digilib is Open Source Software under the Lesser General Public License, jointly developed by the Max-Planck-Institute for the History of Science, the Bibliotheca Hertziana, the University of Bern and others.

Where can I get digilib?

• Source code
• Issue tracker
• Daily built WAR files
• Daily built Javadoc
• Maven repository

digilib documentation can be found on the digilib documentation pages on GitHub or on SourceForge.

How do I run digilib?

Requirements:

• git
• Java JDK version 7 or later
• Maven version 3 or later

Build:

1. Clone the digilib repository

   git clone https://github.com/robcast/digilib.git

2. Change to the repository

   cd digilib

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

   mvn jetty:run-exploded --projects webapp

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

or follow the build and install instructions on the documentation pages.