Mercurial > hg > digilib

comparison doc/src/site/markdown/digilib-config.md @ 1664:6420df6b213b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More documentation.
author Robert Casties <r0bcas7@gmail.com>
date Tue, 21 Nov 2017 20:30:34 +0100
parents 28df291d4e26
children 57fef2cd6540
comparison
equal deleted inserted replaced
1663:a243eb5cc480 1664:6420df6b213b
33 33
34 If relative paths are provided as file locations, these will be resolved with 34 If relative paths are provided as file locations, these will be resolved with
35 the web application's directory as base. 35 the web application's directory as base.
36 36
37 You can inspect a summary of your running digilib configuration at the URL 37 You can inspect a summary of your running digilib configuration at the URL
38 `<base_url>/server/dlConfig.jsp`. 38 `<base_url>/server/dlConfig.jsp` e.g. <http://localhost:8080/digilib/server/dlConfig.jsp>.
39 39
40 ### Image locations 40 ### Image locations
41 41
42 ```xml 42 ```xml
43 <parameter name="basedir-list" value="sample-images" /> 43 <parameter name="basedir-list" value="sample-images" />
44 ``` 44 ```
45 45
46 A list of directories where images are searched. See 46 A list of directories where images are searched. See
47 [this document](image-directories.html) for details. 47 [this document](image-directories.html) for details (**required**).
48 48
49 ```xml 49 ```xml
50 <parameter name="denied-image" value="img/digilib-denied.png" /> 50 <parameter name="denied-image" value="img/digilib-denied.png" />
51 ``` 51 ```
52 52
77 77
78 The location of the mapping file. Refer to 78 The location of the mapping file. Refer to
79 [digilib-map.xml.template](https://github.com/robcast/digilib/blob/master/webapp/src/main/webapp/WEB-INF/digilib-map.xml.template) 79 [digilib-map.xml.template](https://github.com/robcast/digilib/blob/master/webapp/src/main/webapp/WEB-INF/digilib-map.xml.template)
80 for an example. 80 for an example.
81 81
82 The file contains `mapping` elements with a `link` attribute containing a 'virtual directory' name that is mapped to the 82 The file contains `mapping` elements with a `link` attribute containing a 'virtual directory' name that is redirected to the
83 directory given in the `dir` attribute. 83 directory given in the `dir` attribute.
84 84
85 85
86 ### Image processing options 86 ### Image processing options
87 87
120 120
121 Details are provided in the 121 Details are provided in the
122 [documentation on authentication and authorization](auth.html). 122 [documentation on authentication and authorization](auth.html).
123 123
124 ```xml 124 ```xml
125 <parameter name="use-authorization" value="false" />
126 ```
127
128 Enables or disables all authorization. If `use-authorization` is `true` you also have to configure
129 `authnops-class`, `authzops-class` and the `auth-file` and its contents.
130
131 ```xml
125 <parameter name="auth-file" value="digilib-auth.xml" /> 132 <parameter name="auth-file" value="digilib-auth.xml" />
126 ``` 133 ```
127 134
128 Configuration file for authentication and authorization. The format and content of the configuration file 135 Configuration file for authentication and authorization. The format and content of the configuration file
129 is determined by the chosen authentication and authorization classes. 136 is determined by the chosen authentication and authorization classes.
144 <parameter name="authzops-class" value="digilib.auth.PathAuthzOps" /> 151 <parameter name="authzops-class" value="digilib.auth.PathAuthzOps" />
145 ``` 152 ```
146 153
147 The class to handle authorization. 154 The class to handle authorization.
148 155
149 ```xml
150 <parameter name="use-authorization" value="false" />
151 ```
152
153 Enable or disable all authorization. If `use-authorization` is `true` it also needs to be configured
154 using `authnops-class` and `authzops-class` and the `auth-file`.
155
156 156
157 ### IIIF API options 157 ### IIIF API options
158 158
159 The options configure the IIIF interface. For more information see the [digilib IIIF documentation](iiif-api) 159 The options configure the IIIF interface. For more information see the [digilib IIIF documentation](iiif-api)
160 160
193 193
194 ```xml 194 ```xml
195 <parameter name="max-waiting-threads" value="20" /> 195 <parameter name="max-waiting-threads" value="20" />
196 ``` 196 ```
197 197
198 The maximum number of requests waiting in the queue before sending "service unavailable". 198 The maximum number of requests waiting in the queue before new requests get "service unavailable".
199 199
200 ```xml 200 ```xml
201 <parameter name="worker-threads" value="2" /> 201 <parameter name="worker-threads" value="2" />
202 ``` 202 ```
203 203
208 ``` 208 ```
209 209
210 Timeout for worker threads in milliseconds. 210 Timeout for worker threads in milliseconds.
211 211
212 212
213 ### Assorted options 213 ### Other options
214 214
215 ```xml 215 ```xml
216 <parameter name="default-errmsg-type" value="image" /> 216 <parameter name="default-errmsg-type" value="image" />
217 ``` 217 ```
218 218
232 232
233 ```xml 233 ```xml
234 <parameter name="log-config-file" value="log4j-config.xml" /> 234 <parameter name="log-config-file" value="log4j-config.xml" />
235 ``` 235 ```
236 236
237 Location of the logging configuration file. The current logger is 237 Location of the logging configuration file. The current logging library is
238 [Log4J 1.2](https://logging.apache.org/log4j/1.2/manual.html). 238 [Log4J 1.2](https://logging.apache.org/log4j/1.2/manual.html).
239 239
240 240 ### Options for developers
241 ### Unknown category 241
242 242 Using these options you can replace default classes used by digilib with your own implementations
243 **TODO** move items to appropriate sections 243 to change the behaviour of digilib.
244 244
245 ```xml 245 ```xml
246 <parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" />
247 ```
248
249
250 Class of the `DocuImage` instance. You can replace the `digilib.image.DocuImage` implementation to use a different image
251 toolkit than Java ImageIO. (There are deprecated alternative implementations in the `common-jai`,
252 `common-imagej` and `common-bioformats` modules.)
253
254 ```xml
255 <parameter name="docuimage-hacks" value="" />
256 ```
257
258 Text string to selectively enable specific `Hacks` in the `DocuImage` implementation
259 (see [the source](https://github.com/robcast/digilib/blob/master/common/src/main/java/digilib/image/ImageLoaderDocuImage.java))
260
261 ```xml
262 <parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" />
246 <parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" /> 263 <parameter name="dirmeta-class" value="digilib.meta.IndexMetaDirMeta" />
247 ``` 264 ```
248 265
249 Class for **TODO**. 266 Classes of the `digilib.meta.FileMeta` and `digilib.meta.DirMeta` implementations. You can change these implementations
267 to change the way digilib finds metadata about image files.
268
269 `IndexMetaFileMeta` and `IndexMetaDirMeta` read metadata from `index.meta` and `*.meta` XML files according to
270 the [index meta standard](http://intern.mpiwg-berlin.mpg.de/digitalhumanities/mpiwg-metadata-documentation/formate/indexmeta-standard).
250 271
251 ```xml 272 ```xml
252 <parameter name="docudirectory-class" value="digilib.io.BaseDirDocuDirectory" /> 273 <parameter name="docudirectory-class" value="digilib.io.BaseDirDocuDirectory" />
253 ``` 274 ```
254 275
255 Class for **TODO**. 276 Class of the `digilib.io.DocuDirectory` implementation. You can change this implementation to change the way
256 277 digilib finds image files (including different resolutions).
257 ```xml 278
258 <parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" />
259 ```
260
261 Class for the `DocuImage` instance, **TODO** elaborate intended use
262
263 ```xml
264 <parameter name="docuimage-hacks" value="" />
265 ```
266
267 **TODO** elaborate
268
269 ```xml
270 <parameter name="filemeta-class" value="digilib.meta.IndexMetaFileMeta" />
271 ```
272 Class for **TODO**.