digilib - The Digital Image Library

# HG changeset patch # User Robert Casties # Date 1511292898 0 # Node ID 1beeb9319d78cc547ac06a7fe24ed6c2a8e94d39 # Parent fe8300fdcd9de32a405c5d972a1a9c54dece7c89 Creating site for 2.5-SNAPSHOT diff -r fe8300fdcd9d -r 1beeb9319d78 auth.html --- a/auth.html Mon Nov 20 20:24:00 2017 +0000 +++ b/auth.html Tue Nov 21 19:34:58 2017 +0000 @@ -1,13 +1,13 @@ - + digilib - The Digital Image Library – Access control @@ -41,7 +41,7 @@

Last Published: 2017-11-20
Last Published: 2017-11-21
|
Version: 2.5-SNAPSHOT

digilib - The Digital Image Library – Building digilib with Maven

Last Published: 2017-11-20
Last Published: 2017-11-21
|
Version: 2.5-SNAPSHOT

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

Additional Maven build options

Some build options have to be activated as Maven profiles with the -P command line option when building digilib. For example, to build digilib with the Manifester servlet (“iiif-presentation”) use:

+ +

mvn -Piiif-presentation package
+

You can add multiple profiles at the same time if necessary.

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.

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.

-Pservlet2 builds a servlet with the the old non-Asynchronous Servlet API (2.3).

This creates a WAR file with the postfix “-srv2”. The build process uses the file webapp/src/main/webapp/WEB-INF/web-2.4.xml as web.xml file.

servlet3

-Pservlet3 builds digillib with the Asynchronous Servlet API (3.0). This is the default profile, it will be used if you do not specify any profile.

This creates a WAR file with the postfix “-srv3”. The build process uses the file webapp/src/main/webapp/WEB-INF/web-3.0.xml as web.xml file.

iiif-presentation

-Piiif-presentation builds digilib with the “Manifester” servlet for IIIF Presentation API support (see digilib IIIF support documentation).

This creates a WAR file with the postfix “-srv3p”. The build process uses the file webapp/src/main/webapp/WEB-INF/web-iiif-pres.xml as web.xml file.

text

-Ptext builds digilib with the “Texter” servlet to download plain text or XML files (see the source). You have to add -Pservlet3 or -Pservlet2 as well.

You also have to copy the mapping for the “Texter” servlet from web-additional.xml into the web.xml file used by the selected servlet API like web-3.0.xml.

pdf

-Ppdf builds digilib with the “PDFCache” servlet to generate and download PDF files from images. (see the source).

You also have to copy the mapping for the “PDFCache” servlet from web-additional.xml into the web.xml file used by the selected servlet API like web-3.0.xml.

create-sprites

-Pcreate-sprites re-creates the image sprite file (webapp/src/main/webapp/jquery/img/dl-buttons-full-32-sprite.png) from the separate icon image files. This option only needs to be used if you are a developer and you want to change the icon images.

running tests

-DskipTests=false enables some functional tests. The tests are run as part of the normal build process. You can also run just the tests with mvn -DskipTests=false test.

digilib - The Digital Image Library – Integrating digilib into your web page

Last Published: 2017-11-20
Last Published: 2017-11-21
|
Version: 2.5-SNAPSHOT

digilib - The Digital Image Library – Configuring digilib

Last Published: 2017-11-20
Last Published: 2017-11-21
|
Version: 2.5-SNAPSHOT

Available parameters

The documented parameter values below are the defaults.

If relative paths are provided as file locations, these will be resolved with the web application’s directory as base.

You can inspect a summary of your running digilib configuration at the URL <base_url>/server/dlConfig.jsp.

You can inspect a summary of your running digilib configuration at the URL <base_url>/server/dlConfig.jsp e.g. http://localhost:8080/digilib/server/dlConfig.jsp.

Image locations

@@ -223,7 +223,7 @@

<parameter name="basedir-list" value="sample-images" />

A list of directories where images are searched. See this document for details.

A list of directories where images are searched. See this document for details (required).

@@ -254,7 +254,7 @@

<parameter name="mapping-file" value="digilib-map.xml" />

The location of the mapping file. Refer to digilib-map.xml.template for an example.

The file contains mapping elements with a link attribute containing a ‘virtual directory’ name that is mapped to the directory given in the dir attribute.

The file contains mapping elements with a link attribute containing a ‘virtual directory’ name that is redirected to the directory given in the dir attribute.

Image processing options

@@ -296,6 +296,12 @@

<parameter name="use-authorization" value="false" />
+

Enables or disables all authorization. If use-authorization is true you also have to configure authnops-class, authzops-class and the auth-file and its contents.

+ +

<parameter name="auth-file" value="digilib-auth.xml" />

Configuration file for authentication and authorization. The format and content of the configuration file is determined by the chosen authentication and authorization classes.

@@ -316,13 +322,7 @@

<parameter name="authzops-class" value="digilib.auth.PathAuthzOps" />

The class to handle authorization.

<parameter name="use-authorization" value="false" />
-

Enable or disable all authorization. If use-authorization is true it also needs to be configured using authnops-class and authzops-class and the auth-file.

The class to handle authorization.

IIIF API options

The options configure the IIIF interface. For more information see the digilib IIIF documentation

@@ -363,7 +363,7 @@

<parameter name="max-waiting-threads" value="20" />

The maximum number of requests waiting in the queue before sending “service unavailable”.

The maximum number of requests waiting in the queue before new requests get “service unavailable”.

@@ -377,7 +377,7 @@

Timeout for worker threads in milliseconds.

Assorted options

Other options

@@ -404,40 +404,36 @@

<parameter name="log-config-file" value="log4j-config.xml" />

Location of the logging configuration file. The current logger is Log4J 1.2.

Location of the logging configuration file. The current logging library is Log4J 1.2.

Unknown category

TODO move items to appropriate sections

Options for developers

Using these options you can replace default classes used by digilib with your own implementations to change the behaviour of digilib.

<parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" />
+<parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" />
+

Class of the DocuImage instance. You can replace the digilib.image.DocuImage implementation to use a different image toolkit than Java ImageIO. (There are deprecated alternative implementations in the common-jai, common-imagej and common-bioformats modules.)

+ +

<parameter name="docuimage-hacks" value="" />

Class for TODO.

Text string to selectively enable specific Hacks in the DocuImage implementation (see the source)

+ +

<parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" />
+<parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" />
+

Classes of the digilib.meta.FileMeta and digilib.meta.DirMeta implementations. You can change these implementations to change the way digilib finds metadata about image files.

IndexMetaFileMeta and IndexMetaDirMeta read metadata from index.meta and *.meta XML files according to the index meta standard.

<parameter name="docudirectory-class" value="digilib.io.BaseDirDocuDirectory" />

Class for TODO.

- -

<parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" />
-

Class for the DocuImage instance, TODO elaborate intended use

- -

<parameter name="docuimage-hacks" value="" />
-

TODO elaborate

- -

<parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" />
-

Class for TODO.

Class of the digilib.io.DocuDirectory implementation. You can change this implementation to change the way digilib finds image files (including different resolutions).

digilib - The Digital Image Library – A short introduction to digilib

Additional Maven build options

servlet2

servlet3

iiif-presentation

text

pdf

create-sprites

running tests

Available parameters

Image locations

Image processing options

IIIF API options

Assorted options

Other options

Unknown category

Options for developers

Start the Servlet Container

Deploy via WAR file or web application directory?

Where to get a WAR file or web application directory?

Install a digilib WAR file