1 | ###########################################################################
|
---|
2 | # Sample Cantaloupe configuration file
|
---|
3 | #
|
---|
4 | # Copy this file to `cantaloupe.properties` and edit as desired.
|
---|
5 | #
|
---|
6 | # Keys may change from version to version. See the "Upgrading" section of
|
---|
7 | # the website.
|
---|
8 | #
|
---|
9 | # Most changes will take effect without restarting. Those that won't are
|
---|
10 | # marked with "!!".
|
---|
11 | ###########################################################################
|
---|
12 |
|
---|
13 | # !! Leave blank to use the JVM default temporary directory.
|
---|
14 | temp_pathname =
|
---|
15 |
|
---|
16 | # !! Configures the HTTP server. (Standalone mode only.)
|
---|
17 | http.enabled = true
|
---|
18 | http.host = 0.0.0.0
|
---|
19 | http.port = 8182
|
---|
20 | http.http2.enabled = false
|
---|
21 |
|
---|
22 | # !! Configures the HTTPS server. (Standalone mode only.)
|
---|
23 | https.enabled = false
|
---|
24 | https.host = 0.0.0.0
|
---|
25 | https.port = 8183
|
---|
26 | # Secure HTTP/2 requires Java 9 or later.
|
---|
27 | https.http2.enabled = false
|
---|
28 |
|
---|
29 | # !! Available values are `JKS` and `PKCS12`. (Standalone mode only.)
|
---|
30 | https.key_store_type = JKS
|
---|
31 | https.key_store_password = myPassword
|
---|
32 | https.key_store_path = /path/to/keystore.jks
|
---|
33 | https.key_password = myPassword
|
---|
34 |
|
---|
35 | # !! Maximum size of the HTTP(S) request queue. Leave blank to use the
|
---|
36 | # default.
|
---|
37 | http.accept_queue_limit =
|
---|
38 |
|
---|
39 | # Base URI to use for internal links, such as Link headers and JSON-LD
|
---|
40 | # @id values, in a reverse-proxy context. This should only be used when
|
---|
41 | # X-Forwarded-* headers cannot be used instead. (See the user manual.)
|
---|
42 | base_uri =
|
---|
43 |
|
---|
44 | # Normally, slashes in a URI path component must be percent-encoded as
|
---|
45 | # "%2F". If your proxy is not able to pass these through without decoding,
|
---|
46 | # you can define an alternate character or character sequence to substitute
|
---|
47 | # for a slash. Supply the non-percent-encoded version here, and use the
|
---|
48 | # percent-encoded version in URLs.
|
---|
49 | slash_substitute =
|
---|
50 |
|
---|
51 | # Maximum number of pixels to return in a response, to prevent overloading
|
---|
52 | # the server. Requests for more pixels than this will receive an error
|
---|
53 | # response. Set to 0 for no maximum.
|
---|
54 | max_pixels = 400000000
|
---|
55 |
|
---|
56 | # Errors will also be logged to the error log (if enabled).
|
---|
57 | print_stack_trace_on_error_pages = true
|
---|
58 |
|
---|
59 | ###########################################################################
|
---|
60 | # DELEGATE SCRIPT
|
---|
61 | ###########################################################################
|
---|
62 |
|
---|
63 | # Enables the delegate script: a Ruby script containing various delegate
|
---|
64 | # methods. (See the user manual.)
|
---|
65 | delegate_script.enabled = false
|
---|
66 |
|
---|
67 | # !! This can be an absolute path, or a filename; if only a filename is
|
---|
68 | # specified, it will be searched for in the same folder as this file, and
|
---|
69 | # then the current working directory.
|
---|
70 | delegate_script.pathname = delegates.rb
|
---|
71 |
|
---|
72 | # Enables the invocation cache, which caches method invocations and return
|
---|
73 | # values in memory. See the user manual for more information.
|
---|
74 | delegate_script.cache.enabled = false
|
---|
75 |
|
---|
76 | ###########################################################################
|
---|
77 | # ENDPOINTS
|
---|
78 | ###########################################################################
|
---|
79 |
|
---|
80 | # !! Configures HTTP Basic authentication in all public endpoints.
|
---|
81 | endpoint.public.auth.basic.enabled = false
|
---|
82 | endpoint.public.auth.basic.username = myself
|
---|
83 | endpoint.public.auth.basic.secret = mypassword
|
---|
84 |
|
---|
85 | # Enables the IIIF Image API 1.x endpoint, at /iiif/1.
|
---|
86 | endpoint.iiif.1.enabled = false
|
---|
87 |
|
---|
88 | # Enables the IIIF Image API 2.x endpoint, at /iiif/2.
|
---|
89 | endpoint.iiif.2.enabled = true
|
---|
90 |
|
---|
91 | # Controls the response Content-Disposition header for images. Allowed
|
---|
92 | # values are `inline`, `attachment`, and `none`. This can be overridden
|
---|
93 | # using the ?response-content-disposition query argument.
|
---|
94 | endpoint.iiif.content_disposition = inline
|
---|
95 |
|
---|
96 | # Minimum size that will be used in info.json `sizes` keys.
|
---|
97 | endpoint.iiif.min_size = 64
|
---|
98 |
|
---|
99 | # Minimum size that will be used in info.json `tiles` keys. The user manual
|
---|
100 | # explains how these are calculated.
|
---|
101 | endpoint.iiif.min_tile_size = 512
|
---|
102 |
|
---|
103 | # If true, requests for sizes other than those contained in an information
|
---|
104 | # response will be denied.
|
---|
105 | endpoint.iiif.2.restrict_to_sizes = false
|
---|
106 |
|
---|
107 | # Enables the Control Panel, at /admin.
|
---|
108 | endpoint.admin.enabled = false
|
---|
109 | endpoint.admin.username = admin
|
---|
110 | endpoint.admin.secret =
|
---|
111 |
|
---|
112 | # Enables the administrative HTTP API. (See the user manual.)
|
---|
113 | endpoint.api.enabled = false
|
---|
114 |
|
---|
115 | # HTTP Basic credentials to access the HTTP API.
|
---|
116 | endpoint.api.username =
|
---|
117 | endpoint.api.secret =
|
---|
118 |
|
---|
119 | ###########################################################################
|
---|
120 | # SOURCES
|
---|
121 | ###########################################################################
|
---|
122 |
|
---|
123 | # Uses one source for all requests. Available values are `FilesystemSource`,
|
---|
124 | # `HttpSource`, `JdbcSource`, `S3Source`, and `AzureStorageSource`.
|
---|
125 | source.static = FilesystemSource
|
---|
126 |
|
---|
127 | # If true, `source.static` will be overridden, and the `source()` delegate
|
---|
128 | # method will be used to select a source per-request.
|
---|
129 | source.delegate = false
|
---|
130 |
|
---|
131 | #----------------------------------------
|
---|
132 | # FilesystemSource
|
---|
133 | #----------------------------------------
|
---|
134 |
|
---|
135 | # How to look up files. Allowed values are `BasicLookupStrategy` and
|
---|
136 | # `ScriptLookupStrategy`. ScriptLookupStrategy uses the delegate script for
|
---|
137 | # dynamic lookups; see the user manual.
|
---|
138 | FilesystemSource.lookup_strategy = BasicLookupStrategy
|
---|
139 |
|
---|
140 | # Server-side path that will be prefixed to the identifier in the URL.
|
---|
141 | # Trailing slash is important!
|
---|
142 | FilesystemSource.BasicLookupStrategy.path_prefix = @gsdl3home@/sites/
|
---|
143 |
|
---|
144 |
|
---|
145 | # Server-side path or extension that will be suffixed to the identifier in
|
---|
146 | # the URL.
|
---|
147 | FilesystemSource.BasicLookupStrategy.path_suffix =
|
---|
148 |
|
---|
149 | #----------------------------------------
|
---|
150 | # HttpSource
|
---|
151 | #----------------------------------------
|
---|
152 |
|
---|
153 | HttpSource.trust_all_certs = false
|
---|
154 | HttpSource.request_timeout =
|
---|
155 |
|
---|
156 | # Tells HttpSource how to look up resources. Allowed values are
|
---|
157 | # `BasicLookupStrategy` and `ScriptLookupStrategy`. ScriptLookupStrategy
|
---|
158 | # uses a delegate method for dynamic lookups; see the user manual.
|
---|
159 | HttpSource.lookup_strategy = BasicLookupStrategy
|
---|
160 |
|
---|
161 | # URL that will be prefixed to the identifier in the request URL.
|
---|
162 | # Trailing slash is important!
|
---|
163 | HttpSource.BasicLookupStrategy.url_prefix = http://localhost/images/
|
---|
164 |
|
---|
165 | # Path, extension, query string, etc. that will be suffixed to the
|
---|
166 | # identifier in the request URL.
|
---|
167 | HttpSource.BasicLookupStrategy.url_suffix =
|
---|
168 |
|
---|
169 | # Enables access to resources that require HTTP Basic authentication.
|
---|
170 | HttpSource.BasicLookupStrategy.auth.basic.username =
|
---|
171 | HttpSource.BasicLookupStrategy.auth.basic.secret =
|
---|
172 |
|
---|
173 | #----------------------------------------
|
---|
174 | # JdbcSource
|
---|
175 | #----------------------------------------
|
---|
176 |
|
---|
177 | # Note: JdbcSource requires some delegate methods to be implemented in
|
---|
178 | # addition to the configuration here, and a JDBC driver to be installed on
|
---|
179 | # the classpath; see the user manual.
|
---|
180 |
|
---|
181 | # !!
|
---|
182 | JdbcSource.url = jdbc:postgresql://localhost:5432/my_database
|
---|
183 | # !!
|
---|
184 | JdbcSource.user = postgres
|
---|
185 | # !!
|
---|
186 | JdbcSource.password = postgres
|
---|
187 |
|
---|
188 | # !! Connection timeout in seconds.
|
---|
189 | JdbcSource.connection_timeout = 10
|
---|
190 |
|
---|
191 | #----------------------------------------
|
---|
192 | # S3Source
|
---|
193 | #----------------------------------------
|
---|
194 |
|
---|
195 | # !! Endpoint URI.
|
---|
196 | # For AWS endpoints, see:
|
---|
197 | # https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
---|
198 | S3Source.endpoint =
|
---|
199 |
|
---|
200 | # !! Credentials for your AWS account.
|
---|
201 | # See: http://aws.amazon.com/security-credentials
|
---|
202 | # Note that this info can be obtained from elsewhere rather than setting
|
---|
203 | # it here; see the user manual.
|
---|
204 | S3Source.access_key_id =
|
---|
205 | S3Source.secret_key =
|
---|
206 |
|
---|
207 | # !! Maximum number of concurrent HTTP connections to AWS. Leave blank to
|
---|
208 | # use the default.
|
---|
209 | S3Source.max_connections =
|
---|
210 |
|
---|
211 | # Tells S3Source how to look up objects. Allowed values are
|
---|
212 | # `BasicLookupStrategy` and `ScriptLookupStrategy`. ScriptLookupStrategy
|
---|
213 | # uses a delegate method for dynamic lookups; see the user manual.
|
---|
214 | S3Source.lookup_strategy = BasicLookupStrategy
|
---|
215 |
|
---|
216 | # !! Name of the bucket containing images to be served.
|
---|
217 | S3Source.BasicLookupStrategy.bucket.name =
|
---|
218 |
|
---|
219 | # Path within the bucket that will be prefixed to the identifier in the URL.
|
---|
220 | # Trailing slash is important!
|
---|
221 | S3Source.BasicLookupStrategy.path_prefix =
|
---|
222 |
|
---|
223 | # Path or extension that will be suffixed to the identifier in the URL.
|
---|
224 | S3Source.BasicLookupStrategy.path_suffix =
|
---|
225 |
|
---|
226 | #----------------------------------------
|
---|
227 | # AzureStorageSource
|
---|
228 | #----------------------------------------
|
---|
229 |
|
---|
230 | # !! Name of your Azure account.
|
---|
231 | # Leave blank if using URI with a SAS token in your object key.
|
---|
232 | AzureStorageSource.account_name =
|
---|
233 |
|
---|
234 | # !! Key of your Azure account.
|
---|
235 | # Leave blank if using URI with a SAS token in your object key.
|
---|
236 | AzureStorageSource.account_key =
|
---|
237 |
|
---|
238 | # !! Name of the container containing images to be served.
|
---|
239 | # Leave blank if using URI with the container in your object key.
|
---|
240 | AzureStorageSource.container_name =
|
---|
241 |
|
---|
242 | # Tells AzureStorageSource how to look up objects. Allowed values are
|
---|
243 | # `BasicLookupStrategy` and `ScriptLookupStrategy`. ScriptLookupStrategy
|
---|
244 | # uses a delegate method for dynamic lookups; see the user manual.
|
---|
245 | AzureStorageSource.lookup_strategy = BasicLookupStrategy
|
---|
246 |
|
---|
247 | ###########################################################################
|
---|
248 | # PROCESSORS
|
---|
249 | ###########################################################################
|
---|
250 |
|
---|
251 | #----------------------------------------
|
---|
252 | # Processor Selection
|
---|
253 | #----------------------------------------
|
---|
254 |
|
---|
255 | # Image processors to use for various source formats. Available values are
|
---|
256 | # `Java2dProcessor`, `GraphicsMagickProcessor`, `ImageMagickProcessor`,
|
---|
257 | # `KakaduDemoProcessor`, `KakaduNativeProcessor`, `OpenJpegProcessor`,
|
---|
258 | # `JaiProcessor`, `PdfBoxProcessor`, and `FfmpegProcessor`.
|
---|
259 |
|
---|
260 | # These extension-specific definitions are optional.
|
---|
261 | processor.avi = FfmpegProcessor
|
---|
262 | processor.bmp =
|
---|
263 | processor.dcm = ImageMagickProcessor
|
---|
264 | processor.flv = FfmpegProcessor
|
---|
265 | processor.gif =
|
---|
266 | processor.jp2 = KakaduNativeProcessor
|
---|
267 | processor.jpg =
|
---|
268 | processor.mov = FfmpegProcessor
|
---|
269 | processor.mp4 = FfmpegProcessor
|
---|
270 | processor.mpg = FfmpegProcessor
|
---|
271 | processor.pdf = PdfBoxProcessor
|
---|
272 | processor.png =
|
---|
273 | processor.tif =
|
---|
274 | processor.webm = FfmpegProcessor
|
---|
275 | processor.webp = ImageMagickProcessor
|
---|
276 |
|
---|
277 | # Fall back to this processor for any formats not assigned above.
|
---|
278 | processor.fallback = Java2dProcessor
|
---|
279 |
|
---|
280 | #----------------------------------------
|
---|
281 | # Global Processor Configuration
|
---|
282 | #----------------------------------------
|
---|
283 |
|
---|
284 | # Controls how content is fed to processors from stream-based sources.
|
---|
285 | # * `StreamStrategy` will try to stream a source image from a source when
|
---|
286 | # possible, and use `processor.fallback_retrieval_strategy` otherwise.
|
---|
287 | # * `DownloadStrategy` will download it to a temporary file, and delete
|
---|
288 | # it after the request is complete.
|
---|
289 | # * `CacheStrategy` will download it into the source cache using
|
---|
290 | # FilesystemCache, which must also be configured. (This will perform a
|
---|
291 | # lot better than DownloadStrategy if you can spare the disk space.)
|
---|
292 | processor.stream_retrieval_strategy = StreamStrategy
|
---|
293 |
|
---|
294 | # Controls how an incompatible StreamSource + FileProcessor combination is
|
---|
295 | # dealt with.
|
---|
296 | # * `DownloadStrategy` and `CacheStrategy` work the same as above.
|
---|
297 | # * `AbortStrategy` causes the request to fail.
|
---|
298 | processor.fallback_retrieval_strategy = DownloadStrategy
|
---|
299 |
|
---|
300 | # Resolution of vector rasterization (of e.g. PDFs) at a scale of 1.
|
---|
301 | processor.dpi = 150
|
---|
302 |
|
---|
303 | # Expands contrast to utilize available dynamic range. This usually requires
|
---|
304 | # the whole source image to be read into memory, so it can be inefficient.
|
---|
305 | processor.normalize = false
|
---|
306 |
|
---|
307 | # Color of the background when an image is rotated or alpha-flattened, for
|
---|
308 | # output formats that don't support transparency.
|
---|
309 | # This may not be respected for indexed color derivative images.
|
---|
310 | processor.background_color = white
|
---|
311 |
|
---|
312 | # Available values are `bell`, `bspline`, `bicubic`, `box`, `hermite`,
|
---|
313 | # `lanczos3`, `mitchell`, `triangle`. (JaiProcessor & KakaduNativeProcessor
|
---|
314 | # ignore these.)
|
---|
315 | processor.downscale_filter = bicubic
|
---|
316 | processor.upscale_filter = bicubic
|
---|
317 |
|
---|
318 | # Intensity of an unsharp mask from 0 to 1.
|
---|
319 | processor.sharpen = 0
|
---|
320 |
|
---|
321 | # Attempts to copy source image metadata (EXIF, IPTC, XMP) into derivative
|
---|
322 | # images. (This is not foolproof; see the user manual.)
|
---|
323 | processor.metadata.preserve = false
|
---|
324 |
|
---|
325 | # Whether to auto-rotate images using the EXIF `Orientation` field.
|
---|
326 | # The check for this field can impair performance slightly.
|
---|
327 | processor.metadata.respect_orientation = false
|
---|
328 |
|
---|
329 | # Progressive JPEGs are usually more compact.
|
---|
330 | processor.jpg.progressive = true
|
---|
331 |
|
---|
332 | # JPEG output quality (1-100).
|
---|
333 | processor.jpg.quality = 80
|
---|
334 |
|
---|
335 | # TIFF output compression type. Available values are `Deflate`, `JPEG`,
|
---|
336 | # `LZW`, and `RLE`. Leave blank for no compression.
|
---|
337 | processor.tif.compression = LZW
|
---|
338 |
|
---|
339 | #----------------------------------------
|
---|
340 | # ImageIO Plugin Preferences
|
---|
341 | #----------------------------------------
|
---|
342 |
|
---|
343 | # These override the default plugins used by the application and should not
|
---|
344 | # normally be changed.
|
---|
345 | processor.imageio.bmp.reader =
|
---|
346 | processor.imageio.gif.reader =
|
---|
347 | processor.imageio.gif.writer =
|
---|
348 | processor.imageio.jpg.reader =
|
---|
349 | processor.imageio.jpg.writer =
|
---|
350 | processor.imageio.png.reader =
|
---|
351 | processor.imageio.png.writer =
|
---|
352 | processor.imageio.tif.reader =
|
---|
353 | processor.imageio.tif.writer =
|
---|
354 |
|
---|
355 | #----------------------------------------
|
---|
356 | # FfmpegProcessor
|
---|
357 | #----------------------------------------
|
---|
358 |
|
---|
359 | # Optional absolute path of the directory containing the FFmpeg binaries.
|
---|
360 | # Overrides the PATH.
|
---|
361 | FfmpegProcessor.path_to_binaries =
|
---|
362 |
|
---|
363 | #----------------------------------------
|
---|
364 | # GraphicsMagickProcessor
|
---|
365 | #----------------------------------------
|
---|
366 |
|
---|
367 | # !! Optional absolute path of the directory containing the GraphicsMagick
|
---|
368 | # binary. Overrides the PATH.
|
---|
369 | GraphicsMagickProcessor.path_to_binaries =
|
---|
370 |
|
---|
371 | #----------------------------------------
|
---|
372 | # ImageMagickProcessor
|
---|
373 | #----------------------------------------
|
---|
374 |
|
---|
375 | # !! Optional absolute path of the directory containing the ImageMagick
|
---|
376 | # binary. Overrides the PATH.
|
---|
377 | ImageMagickProcessor.path_to_binaries =
|
---|
378 |
|
---|
379 | #----------------------------------------
|
---|
380 | # KakaduDemoProcessor
|
---|
381 | #----------------------------------------
|
---|
382 |
|
---|
383 | # Optional absolute path of the directory containing kdu_expand.
|
---|
384 | # Overrides the PATH.
|
---|
385 | KakaduDemoProcessor.path_to_binaries =
|
---|
386 |
|
---|
387 | #----------------------------------------
|
---|
388 | # OpenJpegProcessor
|
---|
389 | #----------------------------------------
|
---|
390 |
|
---|
391 | # Optional absolute path of the directory containing opj_decompress.
|
---|
392 | # Overrides the PATH.
|
---|
393 | OpenJpegProcessor.path_to_binaries =
|
---|
394 |
|
---|
395 | ###########################################################################
|
---|
396 | # CLIENT-SIDE CACHING
|
---|
397 | ###########################################################################
|
---|
398 |
|
---|
399 | # Whether to enable the response Cache-Control header.
|
---|
400 | cache.client.enabled = true
|
---|
401 |
|
---|
402 | cache.client.max_age = 2592000
|
---|
403 | cache.client.shared_max_age =
|
---|
404 | cache.client.public = true
|
---|
405 | cache.client.private = false
|
---|
406 | cache.client.no_cache = false
|
---|
407 | cache.client.no_store = false
|
---|
408 | cache.client.must_revalidate = false
|
---|
409 | cache.client.proxy_revalidate = false
|
---|
410 | cache.client.no_transform = true
|
---|
411 |
|
---|
412 | ###########################################################################
|
---|
413 | # SERVER-SIDE CACHING
|
---|
414 | ###########################################################################
|
---|
415 |
|
---|
416 | # N.B.: The source cache may be used if the
|
---|
417 | # `processor.stream_retrieval_strategy` and/or
|
---|
418 | # `processor.fallback_retrieval_strategy` keys are set to `CacheStrategy`.
|
---|
419 |
|
---|
420 | # FilesystemCache is the only available source cache.
|
---|
421 | cache.server.source = FilesystemCache
|
---|
422 |
|
---|
423 | # Amount of time source cache content remains valid. Set to blank or 0
|
---|
424 | # for forever.
|
---|
425 | cache.server.source.ttl_seconds = 2592000
|
---|
426 |
|
---|
427 | # Enables the derivative (processed image) cache.
|
---|
428 | cache.server.derivative.enabled = false
|
---|
429 |
|
---|
430 | # Available values are `FilesystemCache`, `JdbcCache`, `RedisCache`,
|
---|
431 | # `HeapCache`, `S3Cache`, and `AzureStorageCache`.
|
---|
432 | cache.server.derivative =
|
---|
433 |
|
---|
434 | # Amount of time derivative cache content remains valid. Set to blank or 0
|
---|
435 | # for forever.
|
---|
436 | cache.server.derivative.ttl_seconds = 2592000
|
---|
437 |
|
---|
438 | # Whether to use the Java heap as a "level 1" cache for image infos, either
|
---|
439 | # independently or in front of a "level 2" derivative cache (if enabled).
|
---|
440 | cache.server.info.enabled = true
|
---|
441 |
|
---|
442 | # If true, when a source reports that the requested source image has gone
|
---|
443 | # missing, all cached information relating to it (if any) will be deleted.
|
---|
444 | # (This is effectively always false when cache.server.resolve_first is also
|
---|
445 | # false.)
|
---|
446 | cache.server.purge_missing = false
|
---|
447 |
|
---|
448 | # If true, the source image will be confirmed to exist before a cached copy
|
---|
449 | # is returned. If false, the cached copy will be returned without checking.
|
---|
450 | # Resolving first is safer but slower.
|
---|
451 | cache.server.resolve_first = false
|
---|
452 |
|
---|
453 | # !! Enables the cache worker, which periodically purges invalid cache
|
---|
454 | # items in the background.
|
---|
455 | cache.server.worker.enabled = false
|
---|
456 |
|
---|
457 | # !! The cache worker will wait this many seconds before starting its
|
---|
458 | # next shift.
|
---|
459 | cache.server.worker.interval = 86400
|
---|
460 |
|
---|
461 | #----------------------------------------
|
---|
462 | # FilesystemCache
|
---|
463 | #----------------------------------------
|
---|
464 |
|
---|
465 | # If this directory does not exist, it will be created automatically.
|
---|
466 | FilesystemCache.pathname = /var/cache/cantaloupe
|
---|
467 |
|
---|
468 | # Levels of folder hierarchy in which to store cached images. Deeper depth
|
---|
469 | # results in fewer files per directory. Set to 0 to disable subdirectories.
|
---|
470 | # Purge the cache after changing this.
|
---|
471 | FilesystemCache.dir.depth = 3
|
---|
472 |
|
---|
473 | # Number of characters in tree directory names. Should be set to
|
---|
474 | # 16^n < (max number of directory entries your filesystem can deal with).
|
---|
475 | # Purge the cache after changing this.
|
---|
476 | FilesystemCache.dir.name_length = 2
|
---|
477 |
|
---|
478 | #----------------------------------------
|
---|
479 | # HeapCache
|
---|
480 | #----------------------------------------
|
---|
481 |
|
---|
482 | # Target cache size, in bytes or a number ending in M, MB, G, GB, etc.
|
---|
483 | # This is not a hard limit, and may be transiently exceeded.
|
---|
484 | # Ensure your heap can accommodate this size.
|
---|
485 | HeapCache.target_size = 2G
|
---|
486 |
|
---|
487 | # If true, the cache contents will be written to a file on exit and during
|
---|
488 | # cache worker shifts, and read back in at startup.
|
---|
489 | HeapCache.persist = false
|
---|
490 |
|
---|
491 | # When the contents are persisted, this specifies the location of the cache
|
---|
492 | # file. If the parent directory does not exist, it will be created
|
---|
493 | # automatically.
|
---|
494 | HeapCache.persist.filesystem.pathname = /var/cache/cantaloupe/heap.cache
|
---|
495 |
|
---|
496 | #----------------------------------------
|
---|
497 | # JdbcCache
|
---|
498 | #----------------------------------------
|
---|
499 |
|
---|
500 | # !!
|
---|
501 | JdbcCache.url = jdbc:postgresql://localhost:5432/cantaloupe
|
---|
502 | # !!
|
---|
503 | JdbcCache.user = postgres
|
---|
504 | # !!
|
---|
505 | JdbcCache.password =
|
---|
506 |
|
---|
507 | # !! Connection timeout in seconds.
|
---|
508 | JdbcCache.connection_timeout = 10
|
---|
509 |
|
---|
510 | # These must be created manually; see the user manual.
|
---|
511 | JdbcCache.derivative_image_table = derivative_cache
|
---|
512 | JdbcCache.info_table = info_cache
|
---|
513 |
|
---|
514 | #----------------------------------------
|
---|
515 | # S3Cache
|
---|
516 | #----------------------------------------
|
---|
517 |
|
---|
518 | # !! Endpoint URI.
|
---|
519 | # For AWS endpoints, see:
|
---|
520 | # https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
---|
521 | S3Cache.endpoint =
|
---|
522 |
|
---|
523 | # !! Credentials for your AWS account.
|
---|
524 | # See: http://aws.amazon.com/security-credentials
|
---|
525 | # Note that this info can be obtained from elsewhere rather than setting it
|
---|
526 | # here; see the user manual.
|
---|
527 | S3Cache.access_key_id =
|
---|
528 | S3Cache.secret_key =
|
---|
529 |
|
---|
530 | # !! Name of a bucket to use to hold cached data.
|
---|
531 | S3Cache.bucket.name =
|
---|
532 |
|
---|
533 | # !! String that will be prefixed to object keys.
|
---|
534 | S3Cache.object_key_prefix =
|
---|
535 |
|
---|
536 | # !! Maximum number of concurrent HTTP connections to AWS. Leave blank to
|
---|
537 | # use the default.
|
---|
538 | S3Cache.max_connections =
|
---|
539 |
|
---|
540 | #----------------------------------------
|
---|
541 | # AzureStorageCache
|
---|
542 | #----------------------------------------
|
---|
543 |
|
---|
544 | # !! Credentials for your Azure account.
|
---|
545 | AzureStorageCache.account_name =
|
---|
546 | AzureStorageCache.account_key =
|
---|
547 |
|
---|
548 | # !! Name of the container containing cached images.
|
---|
549 | AzureStorageCache.container_name =
|
---|
550 |
|
---|
551 | # !! String that will be prefixed to object keys.
|
---|
552 | AzureStorageCache.object_key_prefix =
|
---|
553 |
|
---|
554 | #----------------------------------------
|
---|
555 | # RedisCache
|
---|
556 | #----------------------------------------
|
---|
557 |
|
---|
558 | # !! Redis connection info.
|
---|
559 | RedisCache.host = localhost
|
---|
560 | RedisCache.port = 6379
|
---|
561 | RedisCache.ssl = false
|
---|
562 | RedisCache.password =
|
---|
563 | RedisCache.database = 0
|
---|
564 |
|
---|
565 | ###########################################################################
|
---|
566 | # OVERLAYS
|
---|
567 | ###########################################################################
|
---|
568 |
|
---|
569 | # Whether to enable overlays.
|
---|
570 | overlays.enabled = false
|
---|
571 |
|
---|
572 | # Controls how overlays are configured. `BasicStrategy` will use the
|
---|
573 | # `overlays.BasicStrategy.*` keys in this section. `ScriptStrategy` will
|
---|
574 | # use a delegate method. (See the user manual.)
|
---|
575 | overlays.strategy = BasicStrategy
|
---|
576 |
|
---|
577 | # `image` or `string`.
|
---|
578 | overlays.BasicStrategy.type = image
|
---|
579 |
|
---|
580 | # Absolute path or URL of the overlay image. Must be a PNG file.
|
---|
581 | overlays.BasicStrategy.image = /path/to/overlay.png
|
---|
582 |
|
---|
583 | # Overlay text.
|
---|
584 | overlays.BasicStrategy.string = Copyright \u00A9ïž My Great Organization\nAll rights reserved.
|
---|
585 |
|
---|
586 | # For possible values, launch with the -Dcantaloupe.list_fonts option.
|
---|
587 | overlays.BasicStrategy.string.font = Helvetica
|
---|
588 |
|
---|
589 | # Font size in points.
|
---|
590 | overlays.BasicStrategy.string.font.size = 24
|
---|
591 |
|
---|
592 | # If the string doesn't fit in the image at the above size, the largest size
|
---|
593 | # at which it does fit will be used, down to this.
|
---|
594 | overlays.BasicStrategy.string.font.min_size = 18
|
---|
595 |
|
---|
596 | # Font weight. 1 = regular, 2 = bold. Unfortunately, many fonts don't
|
---|
597 | # support fractional weights.
|
---|
598 | overlays.BasicStrategy.string.font.weight = 1.0
|
---|
599 |
|
---|
600 | # Point spacing between glyphs, typically between -0.1 and 0.1.
|
---|
601 | overlays.BasicStrategy.string.glyph_spacing = 0.02
|
---|
602 |
|
---|
603 | # CSS color syntax is supported.
|
---|
604 | overlays.BasicStrategy.string.color = white
|
---|
605 |
|
---|
606 | # CSS color syntax is supported.
|
---|
607 | overlays.BasicStrategy.string.stroke.color = black
|
---|
608 |
|
---|
609 | # Stroke width in pixels.
|
---|
610 | overlays.BasicStrategy.string.stroke.width = 1
|
---|
611 |
|
---|
612 | # Color of a rectangular background to draw under the string.
|
---|
613 | # CSS color syntax and alpha are supported.
|
---|
614 | overlays.BasicStrategy.string.background.color = rgba(0, 0, 0, 100)
|
---|
615 |
|
---|
616 | # Allowed values: `top left`, `top center`, `top right`, `left center`,
|
---|
617 | # `center`, `right center`, `bottom left`, `bottom center`, `bottom right`.
|
---|
618 | overlays.BasicStrategy.position = bottom right
|
---|
619 |
|
---|
620 | # Pixel margin between the overlay and the image edge.
|
---|
621 | overlays.BasicStrategy.inset = 10
|
---|
622 |
|
---|
623 | # Output images less than this many pixels wide will not receive an overlay.
|
---|
624 | # Set to 0 to add the overlay regardless.
|
---|
625 | overlays.BasicStrategy.output_width_threshold = 400
|
---|
626 |
|
---|
627 | # Output images less than this many pixels tall will not receive an overlay.
|
---|
628 | # Set to 0 to add the overlay regardless.
|
---|
629 | overlays.BasicStrategy.output_height_threshold = 300
|
---|
630 |
|
---|
631 | ###########################################################################
|
---|
632 | # REDACTIONS
|
---|
633 | ###########################################################################
|
---|
634 |
|
---|
635 | # See the user manual for information about how redactions work.
|
---|
636 | redaction.enabled = false
|
---|
637 |
|
---|
638 | ###########################################################################
|
---|
639 | # LOGGING
|
---|
640 | ###########################################################################
|
---|
641 |
|
---|
642 | #----------------------------------------
|
---|
643 | # Application Log
|
---|
644 | #----------------------------------------
|
---|
645 |
|
---|
646 | # `trace`, `debug`, `info`, `warn`, `error`, `all`, or `off`
|
---|
647 | log.application.level = debug
|
---|
648 |
|
---|
649 | log.application.ConsoleAppender.enabled = true
|
---|
650 |
|
---|
651 | # N.B.: Don't enable FileAppender and RollingFileAppender simultaneously!
|
---|
652 | log.application.FileAppender.enabled = false
|
---|
653 | log.application.FileAppender.pathname = /path/to/logs/application.log
|
---|
654 |
|
---|
655 | log.application.RollingFileAppender.enabled = false
|
---|
656 | log.application.RollingFileAppender.pathname = /path/to/logs/application.log
|
---|
657 | log.application.RollingFileAppender.policy = TimeBasedRollingPolicy
|
---|
658 | log.application.RollingFileAppender.TimeBasedRollingPolicy.filename_pattern = /path/to/logs/application-%d{yyyy-MM-dd}.log
|
---|
659 | log.application.RollingFileAppender.TimeBasedRollingPolicy.max_history = 30
|
---|
660 |
|
---|
661 | # See the "SyslogAppender" section for a list of facilities:
|
---|
662 | # http://logback.qos.ch/manual/appenders.html
|
---|
663 | log.application.SyslogAppender.enabled = false
|
---|
664 | log.application.SyslogAppender.host =
|
---|
665 | log.application.SyslogAppender.port = 514
|
---|
666 | log.application.SyslogAppender.facility = LOCAL0
|
---|
667 |
|
---|
668 | #----------------------------------------
|
---|
669 | # Error Log
|
---|
670 | #----------------------------------------
|
---|
671 |
|
---|
672 | # Application log messages with a severity of WARN or greater can be copied
|
---|
673 | # into a dedicated error log, which may make them easier to spot.
|
---|
674 |
|
---|
675 | # N.B.: Don't enable FileAppender and RollingFileAppender simultaneously!
|
---|
676 | log.error.FileAppender.enabled = false
|
---|
677 | log.error.FileAppender.pathname = /path/to/logs/error.log
|
---|
678 |
|
---|
679 | log.error.RollingFileAppender.enabled = false
|
---|
680 | log.error.RollingFileAppender.pathname = /path/to/logs/error.log
|
---|
681 | log.error.RollingFileAppender.policy = TimeBasedRollingPolicy
|
---|
682 | log.error.RollingFileAppender.TimeBasedRollingPolicy.filename_pattern = /path/to/logs/error-%d{yyyy-MM-dd}.log
|
---|
683 | log.error.RollingFileAppender.TimeBasedRollingPolicy.max_history = 30
|
---|
684 |
|
---|
685 | #----------------------------------------
|
---|
686 | # Access Log
|
---|
687 | #----------------------------------------
|
---|
688 |
|
---|
689 | log.access.ConsoleAppender.enabled = false
|
---|
690 |
|
---|
691 | # N.B.: Don't enable FileAppender and RollingFileAppender simultaneously!
|
---|
692 | log.access.FileAppender.enabled = false
|
---|
693 | log.access.FileAppender.pathname = /path/to/logs/access.log
|
---|
694 |
|
---|
695 | # RollingFileAppender is an alternative to using something like
|
---|
696 | # FileAppender + logrotate.
|
---|
697 | log.access.RollingFileAppender.enabled = false
|
---|
698 | log.access.RollingFileAppender.pathname = /path/to/logs/access.log
|
---|
699 | log.access.RollingFileAppender.policy = TimeBasedRollingPolicy
|
---|
700 | log.access.RollingFileAppender.TimeBasedRollingPolicy.filename_pattern = /path/to/logs/access-%d{yyyy-MM-dd}.log
|
---|
701 | log.access.RollingFileAppender.TimeBasedRollingPolicy.max_history = 30
|
---|
702 |
|
---|
703 | # See the "SyslogAppender" section for a list of facilities:
|
---|
704 | # http://logback.qos.ch/manual/appenders.html
|
---|
705 | log.access.SyslogAppender.enabled = false
|
---|
706 | log.access.SyslogAppender.host =
|
---|
707 | log.access.SyslogAppender.port = 514
|
---|
708 | log.access.SyslogAppender.facility = LOCAL0
|
---|