From b2ec4598fe51687e1bd84dfd41f2fe14e146cbe6 Mon Sep 17 00:00:00 2001 From: Robert Casties Date: Thu, 7 Dec 2023 14:00:33 +0100 Subject: [PATCH] document more config options. --- doc/src/site/markdown/digilib-config.md | 7 +++++++ doc/src/site/markdown/iiif-api.md | 7 ++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/src/site/markdown/digilib-config.md b/doc/src/site/markdown/digilib-config.md index 5a1adf69..cfb944ae 100644 --- a/doc/src/site/markdown/digilib-config.md +++ b/doc/src/site/markdown/digilib-config.md @@ -204,6 +204,13 @@ The prefix (after `Scaler`) that leads to the IIIF API. The character that replaces a slash in the identifier of IIIF requests. +```xml + +``` + +The base URL used in constructing IIIF information resource URLs (needs to include servlet name and iiif-prefix). +This is only necessary in some cases behind a proxy. + ### Threading options diff --git a/doc/src/site/markdown/iiif-api.md b/doc/src/site/markdown/iiif-api.md index 9684291b..34f8555d 100644 --- a/doc/src/site/markdown/iiif-api.md +++ b/doc/src/site/markdown/iiif-api.md @@ -81,6 +81,11 @@ in a directory with images then the contents of that file are added to the top-l information to the manifest. The configuration parameter `iiif-manifest-page-label` determines the format of the label of each image: -`filename` uses the image file name (default, sans extension), `index` uses the index (counting from 1). +the value `filename` uses the image file name (default, sans extension), `index` uses the index (counting from 1). +Additional configuration parameters can optionally be used to fix the generation of URLs in the IIIF presentation +API output when running behind a proxy that changes URL paths: + * `iiif-manifest-base-url`: base URL used in constructing IIIF manifests including servlet name and iiif-prefix + * `webapp-base-url`: web-application base URL used in constructing API paths + * `scaler-servlet-name`: Scaler servlet name used in constructing IIIF image API paths