Mercurial > hg > digilib

annotate build/docker/README.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 439aefc7a6c9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1705
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
1 # digilib
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
2
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
3 ![digilib-logo](https://robcast.github.io/digilib/images/digilib-logo-big.png)
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
4
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
5 A Docker container for the [digilib image server](https://robcast.github.io/digilib/).
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
6
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
7 digilib is a [IIIF API](https://iiif.io) compliant image server written in Java:
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
8 * Documentation: https://robcast.github.io/digilib/
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
9 * Issues: https://github.com/robcast/digilib/issues
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
10 * Source code: https://github.com/robcast/digilib
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
11
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
12 ## Supported tags
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
13
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
14 * **release-x.y.z**: Tagged release builds.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
15 * **snapshot**: unstable daily builds from the `master` branch.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
16
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
17 ## Dependencies
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
18
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
19 The digilib runtime image builds on the [tomcat:9-jre11](https://hub.docker.com/_/tomcat) image.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
20
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
21 ## How to use this image
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
22
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
23 Quick try-out using built-in images:
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
24 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
25 docker run --rm -p 8080:8080 robcast/digilib
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
26 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
27 Then open https://localhost:8080/digilib/digilib.html in your browser.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
28
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
29 To use your own images in the directory `/your/image/path` on your host system:
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
30 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
31 docker run --rm \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
32 -p 8080:8080 \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
33 --name digilib \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
34 -e BASEDIR_LIST="/var/lib/images" \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
35 -v /your/image/path:/var/lib/images \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
36 robcast/digilib
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
37 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
38
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
39 ## Available parameters for the container
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
40
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
41 You can set the values of the most important digilib configuration parameters as environment variables
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
42 using the `-e` option of `docker run`. For more information check the
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
43 [digilib-config documentation](https://robcast.github.io/digilib/digilib-config.html).
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
44
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
45 * BASEDIR_LIST: The list of directories where images are searched.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
46
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
47 * DEFAULT_QUALITY: The default interpolation quality (0: do not use interpolation (worst),
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
48 1: use linear interpolation,
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
49 2: use bilinear interpolation and blur-before-scale (best, default))
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
50
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
51 * MAX_IMAGE_SIZE: The maximum size of delivered images as pixel area, 40000 means up to 200x200 or 100x400,
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
52 0 (default) means no limit.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
53
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
54 * SENDFILE_ALLOWED: Is sending whole image files with mo=file allowed (default: "true")?
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
55
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
56 * WORKER_THREADS: Number of parallel working threads (default: 2).
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
57
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
58 * MAX_WAITING_THREADS: Maximum number of waiting requests in queue (default: 20).
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
59
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
60 * IIIF_PREFIX: The URL prefix (after Scaler) that leads to the IIIF API (default: "IIIF")
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
61
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
62 ## Using your own `digilib-config.xml`
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
63
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
64 If you need more control over your [digilib configuration](https://robcast.github.io/digilib/digilib-config.html)
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
65 then you can supply your own `digilib-config.xml` file by mounting it
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
66 to `/usr/local/tomcat/webapps/digilib/WEB-INF/digilib-config.xml` in the container:
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
67 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
68 docker run --rm \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
69 -p 8080:8080 \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
70 --name digilib \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
71 -v digilib-config.xml:/usr/local/tomcat/webapps/digilib/WEB-INF/digilib-config.xml
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
72 -v /your/image/path:/var/lib/images \
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
73 robcast/digilib
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
74 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
75
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
76 Note: when you use your own config file you can not use the predefined parameters described above.
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
77
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
78 ## Building your own container image
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
79
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
80 You can build your own digilib container image from the digilib sources:
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
81 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
82 git clone https://github.com/robcast/digilib.git
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
83 cd digilib
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
84 docker build -f build/docker/Dockerfile -t mydigilib:latest .
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
85 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
86
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
87 You can supply additional options to Maven during the build process using the `MVM_ARGS` build parameter:
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
88 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
89 docker build -f build/docker/Dockerfile -t mydigilib:latest --build-arg MVN_ARGS="-Piiif-presentation" .
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
90 ```
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents:
diff changeset
91 See the [digilib build documentation](https://robcast.github.io/digilib/build-maven.html) for more information.