Mercurial > hg > digilib

annotate doc/src/site/markdown/digilib-config.md @ 1714:d497eb11141c default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated travis-ci config for automatic WAR releases.
author Robert Casties <casties@mpiwg-berlin.mpg.de>
date Mon, 18 Feb 2019 20:49:15 +0100
parents 57fef2cd6540
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
1 # Configuring digilib
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
2
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
3 The main configuration for *digilib* is the XML file `digilib-config.xml` in the
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
4 `WEB-INF` directory of the webapp. Alternatively you can also use a Java properties
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
5 file `digilib.properties` somewhere in the classpath.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
6 (If you really need a different location for the XML file you can define it in
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
7 the `config-file` init-parameter to the Servlet. **TODO** add an example)
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
8
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
9 In the configuration file you can set lots of paths and options. *digilib* uses
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
10 default values for all configuration settings that meet most requirements.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
11 Hence you have to configure only the settings that you want to change. The
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
12 **`basedir-list`** parameter however is **mandatory** unless you only want to serve
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
13 the contributed example images for an evaluation.
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
14
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
15 All options are defined as `parameter` elements with the attributes `name` and
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
16 `value` that are wrapped in the root element `digilib-config`. A minimal
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
17 configuration looks like this:
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
18
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
19 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
20 <?xml version="1.0" encoding="UTF-8"?>
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
21 <digilib-config>
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
22 <parameter name="basedir-list" value="/usr/local/images" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
23 </digilib-config>
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
24 ```
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
25
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
26 A more extensive example is included in the sources as
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
27 [digilib-config.xml.template](https://github.com/robcast/digilib/blob/master/webapp/src/main/webapp/WEB-INF/digilib-config.xml.template).
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
28
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
29
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
30 ## Available parameters
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
31
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
32 The documented parameter values below are the defaults.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
33
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
34 If relative paths are provided as file locations, these will be resolved with
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
35 the web application's directory as base.
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
36
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
37 You can inspect a summary of your running digilib configuration at the URL
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
38 `<base_url>/server/dlConfig.jsp` e.g. <http://localhost:8080/digilib/server/dlConfig.jsp>.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
39
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
40 ### Image locations
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
41
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
42 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
43 <parameter name="basedir-list" value="sample-images" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
44 ```
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
45
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
46 A list of directories where images are searched. See
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
47 [this document](image-directories.html) for details (**required**).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
48
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
49 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
50 <parameter name="denied-image" value="img/digilib-denied.png" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
51 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
52
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
53 This image is sent to indicate an authorization failure.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
54
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
55 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
56 <parameter name="error-image" value="img/digilib-error.png" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
57 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
58
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
59 This image is sent to indicate a general failure.
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
60
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
61 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
62 <parameter name="notfound-image" value="img/digilib-notfound.png" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
63 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
64
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
65 This image to sent to indicate that the requested image does not exist or could not be read.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
66
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
67 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
68 <parameter name="use-mapping" value="false" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
69 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
70
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
71 Enables the mapping of 'virtual directories' to actual directories in the
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
72 filesystem using a mapping file.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
73
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
74 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
75 <parameter name="mapping-file" value="digilib-map.xml" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
76 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
77
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
78 The location of the mapping file. Refer to
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
79 [digilib-map.xml.template](https://github.com/robcast/digilib/blob/master/webapp/src/main/webapp/WEB-INF/digilib-map.xml.template)
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
80 for an example.
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
81
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
82 The file contains `mapping` elements with a `link` attribute containing a 'virtual directory' name that is redirected to the
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
83 directory given in the `dir` attribute.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
84
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
85
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
86 ### Image processing options
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
87
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
88 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
89 <parameter name="default-quality" value="2" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
90 ```
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
91
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
92 The default interpolation quality.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
93
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
94 * `0`: do not use interpolation (worst),
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
95 * `1`: use linear interpolation,
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
96 * `2`: use bilinear interpolation and blur-before-scale (best).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
97
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
98 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
99 <parameter name="max-image-size" value="0" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
100 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
101
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
102 The maximum size of delivered images as pixel area, `40000` means up to 200x200 or 100x400, `0` means no limit.
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
103
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
104 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
105 <parameter name="sendfile-allowed" value="true" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
106 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
107
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
108 Defines whether requests with `mo=file` or `mo=rawfile` as parameter are allowed to download files (see
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
109 [Scaler API](scaler-api.html)).
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
110
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
111 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
112 <parameter name="subsample-minimum" value="2.0" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
113 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
114
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
115 Degree of subsampling on image load. This is the minimum factor that is scaled by interpolation and not by
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
116 subsampling, i.e. by skipping pixels.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
117
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
118
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
119 ### Authentication and authorization
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
120
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
121 Details are provided in the
1530
70e1225fe08c added auth* documentation.
robcast
parents: 1402
diff changeset
122 [documentation on authentication and authorization](auth.html).
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
123
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
124 ```xml
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
125 <parameter name="use-authorization" value="false" />
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
126 ```
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
127
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
128 Enables or disables all authorization. If `use-authorization` is `true` you also have to configure
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
129 `authnops-class`, `authzops-class` and the `auth-file` and its contents.
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
130
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
131 ```xml
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
132 <parameter name="auth-file" value="digilib-auth.xml" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
133 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
134
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
135 Configuration file for authentication and authorization. The format and content of the configuration file
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
136 is determined by the chosen authentication and authorization classes.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
137
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
138 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
139 <parameter name="authn-token-cookie" value="id_token" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
140 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
141
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
142 The name of the cookie that holds the authentication token for `digilib.auth.OpenIdAuthnOps`.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
143
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
144 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
145 <parameter name="authnops-class" value="digilib.auth.IpAuthnOps" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
146 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
147
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
148 The class to handle authentication.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
149
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
150 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
151 <parameter name="authzops-class" value="digilib.auth.PathAuthzOps" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
152 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
153
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
154 The class to handle authorization.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
155
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
156
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
157 ### IIIF API options
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
158
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
159 The options configure the IIIF interface. For more information see the [digilib IIIF documentation](iiif-api)
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
160
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
161 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
162 <parameter name="iiif-api-version" value="2.1" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
163 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
164
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
165 The IIIF API version for the generated `info.json` information response.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
166
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
167 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
168 <parameter name="iiif-info-cors" value="true" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
169 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
170
1665
57fef2cd6540 Still more documentation fixes.
Robert Casties <r0bcas7@gmail.com>
parents: 1664
diff changeset
171 Enables the [Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
57fef2cd6540 Still more documentation fixes.
Robert Casties <r0bcas7@gmail.com>
parents: 1664
diff changeset
172 header in IIIF info requests (`Access-Control-Allow-Origin: *`).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
173
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
174 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
175 <parameter name="iiif-image-cors" value="true" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
176 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
177
1665
57fef2cd6540 Still more documentation fixes.
Robert Casties <r0bcas7@gmail.com>
parents: 1664
diff changeset
178 Enables the [Cross-Origin Resource Sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
57fef2cd6540 Still more documentation fixes.
Robert Casties <r0bcas7@gmail.com>
parents: 1664
diff changeset
179 header in IIIF image requests (`Access-Control-Allow-Origin: *`).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
180
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
181 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
182 <parameter name="iiif-prefix" value="IIIF" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
183 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
184
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
185 The prefix (after `Scaler`) that leads to the IIIF API.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
186
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
187 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
188 <parameter name="iiif-slash-replacement" value="!" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
189 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
190
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
191 The character that replaces a slash in the identifier of IIIF requests.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
192
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
193
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
194 ### Threading options
1216
bd7dfa8b164e move new digilib doc from https://it-dev.mpiwg-berlin.mpg.de/hg/digilib-doc into main repo.
robcast
parents:
diff changeset
195
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
196 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
197 <parameter name="max-waiting-threads" value="20" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
198 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
199
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
200 The maximum number of requests waiting in the queue before new requests get "service unavailable".
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
201
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
202 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
203 <parameter name="worker-threads" value="2" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
204 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
205
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
206 The maximum number of concurrently working threads.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
207
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
208 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
209 <parameter name="worker-timeout" value="60000" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
210 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
211
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
212 Timeout for worker threads in milliseconds.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
213
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
214
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
215 ### Other options
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
216
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
217 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
218 <parameter name="default-errmsg-type" value="image" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
219 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
220
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
221 Defines how errors are presented to the user. Allowed values are `code`, `image` and
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
222 `text`.
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
223
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
224 * `image` sends an error-image as error code (see `denied-image`, `error-image`, `notfound-image` parameters).
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
225 * `code` sends an HTTP error code, which may result in a broken image display in the browser.
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
226 * `text` sends a plain-text error message, which may result in a broken image display in the browser.
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
227
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
228 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
229 <parameter name="img-diskcache-allowed" value="false" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
230 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
231
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
232 Enables the use of a disk cache for the image toolkit. Using the disk cache may leak file handles
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
233 and lead to resource issues if digilib runs for a long time.
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
234
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
235 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
236 <parameter name="log-config-file" value="log4j-config.xml" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
237 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
238
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
239 Location of the logging configuration file. The current logging library is
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1655
diff changeset
240 [Log4J 1.2](https://logging.apache.org/log4j/1.2/manual.html).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
241
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
242 ### Options for developers
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
243
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
244 Using these options you can replace default classes used by digilib with your own implementations
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
245 to change the behaviour of digilib.
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
246
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
247 ```xml
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
248 <parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" />
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
249 ```
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
250
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
251
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
252 Class of the `DocuImage` instance. You can replace the `digilib.image.DocuImage` implementation to use a different image
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
253 toolkit than Java ImageIO. (There are deprecated alternative implementations in the `common-jai`,
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
254 `common-imagej` and `common-bioformats` modules.)
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
255
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
256 ```xml
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
257 <parameter name="docuimage-hacks" value="" />
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
258 ```
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
259
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
260 Text string to selectively enable specific `Hacks` in the `DocuImage` implementation
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
261 (see [the source](https://github.com/robcast/digilib/blob/master/common/src/main/java/digilib/image/ImageLoaderDocuImage.java))
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
262
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
263 ```xml
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
264 <parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" />
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
265 <parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
266 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
267
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
268 Classes of the `digilib.meta.FileMeta` and `digilib.meta.DirMeta` implementations. You can change these implementations
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
269 to change the way digilib finds metadata about image files.
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
270
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
271 `IndexMetaFileMeta` and `IndexMetaDirMeta` read metadata from `index.meta` and `*.meta` XML files according to
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
272 the [index meta standard](http://intern.mpiwg-berlin.mpg.de/digitalhumanities/mpiwg-metadata-documentation/formate/indexmeta-standard).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
273
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
274 ```xml
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
275 <parameter name="docudirectory-class" value="digilib.io.BaseDirDocuDirectory" />
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
276 ```
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
277
1664
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
278 Class of the `digilib.io.DocuDirectory` implementation. You can change this implementation to change the way
6420df6b213b More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
279 digilib finds image files (including different resolutions).
1655
7310735dd5b5 Refactoring of the configuration docs
Frank Sachsenheim <funkyfuture@riseup.net>
parents: 1530
diff changeset
280