From 39903b1c17577ec58ff23ede97d1e80685c29efc Mon Sep 17 00:00:00 2001
From: Ruven <ruven@users.sourceforge.net>
Date: Fri, 20 Oct 2023 22:39:30 +0200
Subject: [PATCH] Updates to READMEs

---
 README        | 234 ++++++++++++++++++--------------------------------
 docker/README |   2 +-
 2 files changed, 83 insertions(+), 153 deletions(-)

diff --git a/README b/README
index 5a147394..137d5a8d 100644
--- a/README
+++ b/README
@@ -12,9 +12,7 @@ IIPImage - High Resolution Streaming Image Server
 
 ABOUT
 -----
-IIPImage is an advanced high-performance feature-rich image server system for web-based streamed viewing and zooming of ultra high-resolution 
-images. It is designed to be fast and bandwidth-efficient with low processor and memory requirements. The system can comfortably handle gigapixel size images as 
-well as advanced image features such as 8, 16 and 32 bits per channel, CIELAB colorimetric images and scientific imagery such as multispectral images, image sequences and 3D surface topologies.
+IIPImage is an advanced high-performance feature-rich image server system for web-based streamed viewing and zooming of ultra high-resolution images. It is designed to be fast and bandwidth-efficient with low processor and memory requirements. The system can comfortably handle gigapixel size images as well as advanced image features such as 8, 16 and 32 bits per channel, CIELAB colorimetric images and scientific imagery such as multispectral images, image sequences and 3D surface topologies.
 
 
 
@@ -27,7 +25,7 @@ FEATURES
 * JPEG, PNG and WebP output support: export of whole or regions of images at any size
 * Supports IIP, Zoomify, DeepZoom and IIIF API's
 * 1, 8, 16 and 32 bit image support including 32 bit floating point support
-* CIELAB support with automatic CIELAB->sRGB colour space conversion
+* CIELAB support with automatic CIELAB->sRGB color space conversion
 * Multispectral and hyperspectral image support
 * Image stacks and image sequence support
 * Dynamic hillshading of 3D surface topologies
@@ -39,13 +37,9 @@ FEATURES
 LICENCE
 -------
 
-iipsrv is released under the GNU General Public License (GPL). See the copyright
-notice COPYING in this directory for licensing details or go to
-http://www.gnu.org/licenses/gpl.html for more details.
+iipsrv is released under the GNU General Public License (GPL). See the copyright notice COPYING in this directory for licensing details or go to http://www.gnu.org/licenses/gpl.html for more details.
 
-If you use IIPImage on a public site and remove the IIP link logo from the 
-client, you must provide a link on your site back to the IIPImage site - 
-https://iipimage.sourceforge.io
+If you use IIPImage on a public site and remove the IIP link logo from the client, you must provide a link on your site back to the IIPImage site - https://iipimage.sourceforge.io
 
 
 
@@ -54,7 +48,7 @@ BUILDING
 
 Building iipsrv requires a C++ compiler and several development libraries.
 
-### LIBRARY REQUIREMENTS
+### Dependencies
 
 #### Required Libraries:
 - [libtiff](https://libtiff.gitlab.io/libtiff/) development files
@@ -62,15 +56,14 @@ Building iipsrv requires a C++ compiler and several development libraries.
 - [libfcgi](https://fastcgi-archives.github.io/) - the latest version of the FCGI development library is bundled with the iipsrv distribution. If no system FCGI library is detected, the bundled version will be used. Use the `--with-fcgi-incl=<path>` and `--with-fcgi-lib=<path>` configure script option if this library is installed in a non-standard location. See COPYING.FCGI for licensing information for these libraries.
 
 #### Optional Libraries:
-- [Kakadu](https://kakadusoftware.com/) for JPEG2000 input support. Note, however, that this is not open source and you will
-need to purchase a license for the source code. In order to use, first build the Kakadu SDK as per the instructions supplied with the SDK. Then, supply the following parameters to the ./configure command: `--with-kakadu=/path/to/kakadu/distribution`
-- [OpenJPEG](http://www.openjpeg.org/) for JPEG2000 input support. OpenJPEG will be disabled if Kakadu support has been enabled. Use the `--with-openjpeg=<path>` configure option if this library is installed in a non-standard location.
+- [Kakadu](https://kakadusoftware.com/) for JPEG2000 input support. Note, however, that this is not open source and you will need to purchase a license for the source code. In order to use, first build the Kakadu SDK as per the instructions supplied with the SDK. Then, supply the following parameters to the ./configure command: `--with-kakadu=/path/to/kakadu/distribution`
+- [OpenJPEG](http://www.openjpeg.org/) for JPEG2000 input support. OpenJPEG will be disabled if Kakadu support has been enabled. Use the `--with-openjpeg=<path>` configure option if this library is installed in a non-standard location
 - [libpng](http://libpng.org/pub/png/) for PNG output support
 - [libwebp](https://developers.google.com/speed/webp) for WebP output support
-- [libmemcached](https://libmemcached.org) for [Memcached](https://www.memcached.org), a high-performance, distributed memory object caching system. If enabled, IIPImage will cache results using this distributed cache, giving IIPImage added speed and scalability.
+- [libmemcached](https://libmemcached.org) for [Memcached](https://www.memcached.org), a high-performance, distributed memory object caching system. If enabled, IIPImage will cache results using this distributed cache, giving IIPImage added speed and scalability
 
 
-### UNIX / Linux / Mac OSX
+### Building on UNIX / Linux / Mac OSX
 
 On UNIX, Linux and Mac OS X based systems, iipsrv can be built using the standard autoconf configure / make build process.
 
@@ -79,9 +72,7 @@ First download iipsrv, then unpack it and change your working directory to be th
     tar jxvf iipsrv-<version>.tar.bz2
     cd iipsrv-<version>
 
-If you are building from a git clone rather than from a release package, you must first generate the configure
-script and autoconf build environment using the provided `autogen.sh` script. This step is not necessary for release
-versions.
+If you are building from a git clone rather than from a release package, you must first generate the configure script and autoconf build environment using the provided `autogen.sh` script. This step is not necessary for release versions.
 
     ./autogen.sh
 
@@ -89,7 +80,7 @@ If you are using a release package, just run configure:
 
     ./configure
 
-Optional libraries are activated by default if found by configure. To manually disable, use the `--disable-<option>` flag. For example `--disable-openjpeg` will disable OpenJPEG support. 
+Optional libraries are activated by default if found by configure. To manually disable, use the `--disable-<option>` flag. For example `--disable-openjpeg` will disable OpenJPEG support.
 
 To see the full list of available configuration options:
 
@@ -102,7 +93,7 @@ Now compile using make:
 The resulting executable is `iipsrv.fcgi` in the `src/` sub-directory.
 
 
-### Windows
+### Building on Windows
 
 For building on Windows, Visual Studio build files are available in the `windows/` sub-directory. These use [vcpkg](https://vcpkg.io/) for dependency management.
 
@@ -120,8 +111,7 @@ Now open the provided iipsrv project with Visual Studio and build. See https://i
 
 DEVELOPMENT DOCUMENTATION
 -------------------------
-Detailed class descriptions (generated using [doxygen](https://www.doxygen.nl/)) are available in the
-doc sub-directory
+Detailed class descriptions (generated using [doxygen](https://www.doxygen.nl/)) are available in the doc sub-directory
 
 
 
@@ -155,7 +145,7 @@ iipsrv can be started directly on the command line using the `--bind` parameter
 
 where the argument given to bind is the socket on which to listen to **FCGI** requests. The socket can be a network (IP address and port) or UNIX file socket. Note that configuration parameters need to be exported as environment variables. See the CONFIGURATION section for more details.
 
-There is additionally a --backlog parameter that is optional and sets the socket backlog value. The backlog value specifies the number of requests can be queued and, therefore, increases the number of concurrent connections that iipsrv can handle and is set to 2048 by default. For example:
+There is additionally a `--backlog` parameter that is optional and sets the socket backlog value. The backlog value specifies the number of requests can be queued and, therefore, increases the number of concurrent connections that iipsrv can handle and is set to 2048 by default. For example:
 
     iipsrv.fcgi --bind 192.168.0.1:9000 --backlog 1024
 
@@ -189,7 +179,6 @@ Make sure the module is installed and loaded:
 Example configuration. Note that there is no need to explicitly start the server:
 
 ```
--------------------------------------------------------------------
 # Create a directory for the iipsrv binary
 ScriptAlias /fcgi-bin/ "/var/www/fcgi-bin/"
 
@@ -221,8 +210,6 @@ FcgidInitialEnv MAX_CVT "3000"
 # processes we want
 FcgidIdleTimeout 0
 FcgidMaxProcessesPerClass 1
-
--------------------------------------------------------------------
 ```
 
 Note that on CentOS, FcgidIPCDir is configured by default to `/var/log/httpd/fcgidsock`, which may not be writable by Apache. If this is the case, specify another location for FcgidIPCDir, which is writable, such as `/tmp/fcgidsock`
@@ -233,7 +220,6 @@ Note that on CentOS, FcgidIPCDir is configured by default to `/var/log/httpd/fcg
 Example configuration if using the mod_fastcgi module:
 
 ```
---------------------------------------------------------------------
 # Create a directory for the iipsrv binary
 ScriptAlias /fcgi-bin/ "/var/www/fcgi-bin/"
 
@@ -265,7 +251,6 @@ FastCgiServer /var/www/fcgi-bin/iipsrv.fcgi \
 -initial-env MAX_CVT=3000 \
 -listen-queue-depth 2048 \
 -processes 1
---------------------------------------------------------------------
 ```
 
 #### Lighttpd
@@ -273,7 +258,6 @@ FastCgiServer /var/www/fcgi-bin/iipsrv.fcgi \
 Lighttpd example extract:
 
 ```
---------------------------------------------------------------------
 fastcgi.server = ( "/fcgi-bin/iipsrv.fcgi" =>
   (( "host" => "0.0.0.0",
      "port" => 9000,
@@ -285,13 +269,11 @@ fastcgi.server = ( "/fcgi-bin/iipsrv.fcgi" =>
         "LOGFILE" => "/tmp/iipsrv.log",
         "VERBOSITY" => "5",
         "MAX_IMAGE_CACHE_SIZE" => "10",
-        "FILENAME_PATTERN" => "_pyr_",
         "JPEG_QUALITY" => "50",
         "MAX_CVT" => "3000"
       )
   ))
 )
---------------------------------------------------------------------
 ```
 
 
@@ -325,11 +307,9 @@ Note that this will also start a clean IIIF URL service at `/iiif'. (See the URI
 
 ### NginX
 
-NginX cannot start or manage iipsrv itself, but it can connect to an existing instance. To set up nginx with iipsrv add a directive such as this to your nginx configuration, which will forward requests to /fcgi-bin/iipsrv.fcgi to a 
-running iipsrv process on port 9000. Change the IP address and port to match your installation.
+NginX cannot start or manage iipsrv itself, but it can connect to an existing instance. To set up nginx with iipsrv add a directive such as this to your nginx configuration, which will forward requests to /fcgi-bin/iipsrv.fcgi to a running iipsrv process on port 9000. Change the IP address and port to match your installation.
 
-```
-location /fcgi-bin/iipsrv.fcgi {
+    location /fcgi-bin/iipsrv.fcgi {
 	fastcgi_pass    0.0.0.0:9000;
 	fastcgi_param   PATH_INFO $fastcgi_script_name;
         fastcgi_param   REQUEST_METHOD $request_method;
@@ -339,19 +319,17 @@ location /fcgi-bin/iipsrv.fcgi {
         fastcgi_param   SERVER_PROTOCOL $server_protocol;
         fastcgi_param   REQUEST_URI $request_uri;
         fastcgi_param   HTTPS $https if_not_empty;
-}
-```
+    }
+
 
 Nginx can also handle load balancing to multiple iipsrv instances, which can be hosted on the same machine on multiple ports or on different hosts. For a multiple host configuration, declare the load balancing like this:
 
-```
-upstream iip {
+    upstream iip {
 	server 192.168.0.1:9000;
 	server 192.168.0.2:9000;
 	server 192.168.0.3:9000;
 	server 192.168.0.4:9000;
-}
-```
+    }
 
 and change the fastcgi_pass parameter in the above location configuration to point to this instead of a fixed address:
 
@@ -360,9 +338,7 @@ and change the fastcgi_pass parameter in the above location configuration to poi
 
 ### Java Application Servers (Tomcat, Jetty, JBoss etc)
 
-IIPImage can also be used with Java Application Servers such as Apache Tomcat, JBoss and Jetty. Simply add 
-the JFastCGI jar file to your webapp and add the following to your web.xml configuration file in order to 
-re-route FCGI requests to the IIPImage server on the specified port.
+IIPImage can also be used with Java Application Servers such as Apache Tomcat, JBoss and Jetty. Simply add the JFastCGI jar file to your webapp and add the following to your web.xml configuration file in order to re-route FCGI requests to the IIPImage server on the specified port.
 
 ```
 <!-- Gateway Servlet to IIPImage FCGI server -->
@@ -383,173 +359,127 @@ re-route FCGI requests to the IIPImage server on the specified port.
 ```
 
 
+DOCKER
+------
+
+A fully configured iipsrv Docker container is available from Docker Hub. To use, simply pull the container and run it:
+
+    docker pull iipsrv/iipsrv
+    docker run -it -p 9000:9000 -p 8080:80 -v /home/images/:/images iipsrv/iipsrv
+
+Images can be made available to the container by binding to a folder on the host machine, In this example, the folder `/home/images/`. Detailed instructions on how to build the Docker image and run the container can be found in ihe README in the `docker/` sub-directory.
+
+
 
 CONFIGURATION
 -------------
 There are several startup variables that can be passed to the server. These need to be passed as environment variables when starting iipsrv on the command line or through a system service script. All variables are optional:
 
 LOGFILE: the server will log its output to the file specified, if it can.
-Version 1.1 and later of iipsrv also supports logging to syslog if “syslog”
-is given as the value.
-
-VERBOSITY: 0 means no logging, 1 is minimal logging, 2 lots of debugging stuff,
-3 even more debugging stuff and 10 a very large amount indeed ;-)
-
-MAX_IMAGE_CACHE_SIZE: Max image cache size to be held in RAM in MB. This is
-a cache of the compressed JPEG image tiles requested by the client.
-The default is 10MB.
-
-FILESYSTEM_PREFIX: This is a prefix automatically added by the server to the 
-beginning of each file system path. This can be useful for security reasons to 
-limit access to certain sub-directories. For example, with a prefix of 
-"/home/images/" set on the server, a request by a client for "image.tif" will 
-point to the path "/home/images/image.tif".  Any reverse directory path 
-component such as ../ is also filtered out. No default value.
-
-FILESYSTEM_SUFFIX: This  is a suffix added to the end of each file system path.
-It can be combined with FILESYSTEM_PREFIX. It is not used in combination with
-FILENAME_PATTERN. If e.g. this is set to ".tif", an image URL such as  "/UUID"
-will look for "${FILESYSTEM_PREFIX}/UUID.tif". In the IIIF info.json document,
-the image @id will be set without the ".tif" suffix.
-
-JPEG_QUALITY: The default JPEG quality factor for compression when the
-client does not specify one. The value should be between 1 (highest level of
-compression) and 100 (highest image quality). The default is 75.
-
-PNG_QUALITY: The default PNG quality factor for compression when the
-client does not specify one. The value should be between 1 (highest level of
-compression) and 9 (highest image quality). The default is 1.
-
-WEBP_QUALITY: The default WebP quality factor for compression when the
-client does not specify one. The value should be between 0 (highest level of
-compression) and 100 (highest image quality). The default is 50.
-
-MAX_CVT: Limits the maximum output image dimensions (in pixels) allowable for dynamic
-image export via the CVT command or for IIIF requests. This prevents huge requests
-from overloading the server. The default is 5000. If set to -1, no limit is set.
-
-ALLOW_UPSCALING: Determines whether an image may be rendered at a size greater
-than that of the source image. A value of 0 will prevent upscaling.
+Version 1.1 and later of iipsrv also supports logging to syslog if “syslog” is given as the value.
+
+VERBOSITY: 0 means no logging, 1 is minimal logging, 2 lots of debugging stuff, 3 even more debugging stuff and 10 a very large amount indeed ;-)
+
+MAX_IMAGE_CACHE_SIZE: Max image cache size to be held in RAM in MB. This is a cache of the compressed JPEG image tiles requested by the client. The default is 10MB.
+
+FILESYSTEM_PREFIX: This is a prefix automatically added by the server to the beginning of each file system path. This can be useful for security reasons to limit access to certain sub-directories. For example, with a prefix of "/home/images/" set on the server, a request by a client for "image.tif" will point to the path "/home/images/image.tif".  Any reverse directory path component such as ../ is also filtered out. No default value.
+
+FILESYSTEM_SUFFIX: This  is a suffix added to the end of each file system path. It can be combined with FILESYSTEM_PREFIX. It is not used in combination with FILENAME_PATTERN. If e.g. this is set to ".tif", an image URL such as  "/UUID" will look for "${FILESYSTEM_PREFIX}/UUID.tif". In the IIIF info.json document, the image @id will be set without the ".tif" suffix.
+
+JPEG_QUALITY: The default JPEG quality factor for compression when the client does not specify one. The value should be between 1 (highest level of compression) and 100 (highest image quality). The default is 75.
+
+PNG_QUALITY: The default PNG quality factor for compression when the client does not specify one. The value should be between 1 (highest level of compression) and 9 (highest image quality). The default is 1.
+
+WEBP_QUALITY: The default WebP quality factor for compression when the client does not specify one. The value should be between 0 (highest level of compression) and 100 (highest image quality). The default is 50.
+
+MAX_CVT: Limits the maximum output image dimensions (in pixels) allowable for dynamic image export via the CVT command or for IIIF requests. This prevents huge requests from overloading the server. The default is 5000. If set to -1, no limit is set.
+
+ALLOW_UPSCALING: Determines whether an image may be rendered at a size greater than that of the source image. A value of 0 will prevent upscaling.
 The default is 1 (upscaling is allowed).
 
-MAX_LAYERS: The maximum number of quality layers to decode for images that support 
-progressive quality encoding, such as JPEG2000. Ignored for other file 
-formats. If not set, half of the available quality layers will be decoded by default.
-If set to -1, all the available layers will be decoded by default.
+MAX_LAYERS: The maximum number of quality layers to decode for images that support progressive quality encoding, such as JPEG2000. Ignored for other file formats. If not set, half of the available quality layers will be decoded by default. If set to -1, all the available layers will be decoded by default.
 
-FILENAME_PATTERN: Pattern that follows the name stem for a 3D or multispectral 
-sequence. eg: "_pyr_" for FZ1_pyr_000_090.tif. The default is "_pyr_". This is 
-only relevant to 3D image sequences.
+FILENAME_PATTERN: Pattern that follows the name stem for a 3D or multispectral sequence. eg: "_pyr_" for FZ1_pyr_000_090.tif. The default is "_pyr_". This is only relevant to 3D image sequences.
 
-WATERMARK: TIFF image to use as watermark file. This image should be not be 
-bigger the tile size used for TIFF tiling. If bigger, it will simply be 
-cropped to the tile size. If smaller, the watermark will be positioned 
-randomly within the available space. The image can be either colour or 
-grayscale.
+WATERMARK: TIFF image to use as watermark file. This image should be not be bigger the tile size used for TIFF tiling. If bigger, it will simply be cropped to the tile size. If smaller, the watermark will be positioned randomly within the available space. The image can be either color or grayscale.
 
-WATERMARK_PROBABILITY: The probability that a particular tile will have a watermark
-applied to it. 0 means never, 1 means always.
+WATERMARK_PROBABILITY: The probability that a particular tile will have a watermark applied to it. 0 means never, 1 means always.
 
 WATERMARK_OPACITY: The opacity (between 0 and 1) applied to the watermark image.
 
-MEMCACHED_SERVERS: A comma-delimitted list of memcached servers with optional
-port numbers. For example: localhost,192.168.0.1:8888,192.168.0.2.
+MEMCACHED_SERVERS: A comma-delimited list of memcached servers with optional port numbers. For example: localhost,192.168.0.1:8888,192.168.0.2.
 
 MEMCACHED_TIMEOUT: Time in seconds that cache remains fresh.
 Default is 86400 seconds (24 hours).
 
-INTERPOLATION: Interpolation method to use for rescaling when using image export.
-Integer value. 0 for fastest nearest neighbour interpolation. 1 for bilinear
-interpolation (better quality but about 2.5x slower). Bilinear by default.
+INTERPOLATION: Interpolation method to use for re-scaling when using image export.
+Integer value. 0 for fastest nearest neighbour interpolation. 1 for bilinear interpolation (better quality but about 2.5x slower). Bilinear by default.
 
 CORS: Cross Origin Resource Sharing setting. Disabled by default.
 Set to * to enable for all domains or specify a single domain.
 See http://www.w3.org/TR/cors/ for more details on CORS.
 
-BASE_URL: Set a base URL for use in certain protocol requests if web server rewriting 
-has taken place and the public URL is not the same as that supplied to iipsrv.
+BASE_URL: Set a base URL for use in certain protocol requests if web server rewriting has taken place and the public URL is not the same as that supplied to iipsrv.
 
-URI_MAP: Set a mapping from a URL prefix to a supported protocol. This enables iipsrv to
-be able to work without requiring full CGI query strings. Map must be of the form
-"prefix=>protocol" where prefix can be either empty or any string prefix and protocol must
-be one of IIP,IIIF,DeepZoom, Zoomify. Used, for example, to map requests of the form
-http://server/iiif/ to the IIIF protocol handler without requiring web server rewriting.
+URI_MAP: Set a mapping from a URL prefix to a supported protocol. This enables iipsrv to be able to work without requiring full CGI query strings. Map must be of the form "prefix=>protocol" where prefix can be either empty or any string prefix and protocol must be one of IIP,IIIF,DeepZoom, Zoomify. Used, for example, to map requests of the form http://server/iiif/ to the IIIF protocol handler without requiring web server rewriting.
 
-CACHE_CONTROL: Set the HTTP Cache-Control header. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 for 
-a full list of options. If not set, header defaults to "max-age=86400" (24 hours).
+CACHE_CONTROL: Set the HTTP Cache-Control header. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9 for a full list of options. If not set, header defaults to "max-age=86400" (24 hours).
 
 EMBED_ICC: Set whether the ICC profile is embedded within the output image.
 0 to strip profile, 1 to embed profile. The default is 1 (embedded profiles).
 
-OMP_NUM_THREADS: Set the number of OpenMP threads to be used by the iipsrv image
-processing routines (See OpenMP specification for details). All available processor
-threads are used by default.
+OMP_NUM_THREADS: Set the number of OpenMP threads to be used by the iipsrv image processing routines (See OpenMP specification for details). All available processor threads are used by default.
 
-KAKADU_READMODE: Set the Kakadu JPEG2000 read-mode. 0 for 'fast' mode with minimal error checking (default), 1 for 'fussy' mode with no error 
-recovery, 2 for 'resilient' mode with maximum recovery from codestream errors. See the Kakadu documentation for further details.
+KAKADU_READMODE: Set the Kakadu JPEG2000 read-mode. 0 for 'fast' mode with minimal error checking (default), 1 for 'fussy' mode with no error recovery, 2 for 'resilient' mode with maximum recovery from codestream errors. See the Kakadu documentation for further details.
 
-IIIF_VERSION: Set the major IIIF Image API version. Values should be a single digit. For example: 2 for versions 2 or 2.1 etc.
-3 for IIIF version 3.x. If not set, defaults to version IIIF 3.x
+IIIF_VERSION: Set the major IIIF Image API version. Values should be a single digit. For example: 2 for versions 2 or 2.1 etc. 3 for IIIF version 3.x. If not set, defaults to version IIIF 3.x
 
 IIIF_DELIMITER: Set delimiter to enable page or slice selection for a multi-page or image stack for IIIF requests.
 Delimiter can be a single character or an arbitrary string. Disabled by default.
 
-DECODER_MODULES: Comma separated list of external modules for decoding 
-other image formats. This is only necessary if you have activated 
---enable-modules for ./configure and written your own image format 
-handler(s).
+DECODER_MODULES: Comma separated list of external modules for decoding other image formats. This is only necessary if you have activated --enable-modules for ./configure and written your own image format handler(s).
+
 
 
+IMAGES
+------
 
-IMAGE PATHS
------------
-The images paths given to the server via the FIF variable must be
-absolute paths on the server machine (eg. FIF=/images/test.tif) 
-and not paths relative to the web server document root location.
-Images do not, therefore, need to be directly accessible by the
-client via the web server. Make sure the server process owner is
-able to access and read the images!
+### Image Input Formats
+Input images must be in either tiled multi-resolution (pyramid) TIFF format or in JPEG2000 format. See https://iipimage.sourceforge.io/documentation/images for details on how to create appropriate images.
+
+### Image Input Paths
+The images paths given to the server via the FIF command for the IIP API or in the IIIF, Deepzoom or Zoomify  requests must be absolute paths on the server machine (eg. FIF=/images/test.tif) and not paths relative to the web server document root location. Images do not, therefore, need to be directly accessible through the web server. The FILESYSTEM_PREFIX configuration parameter can be used to avoid overly long image paths. Make sure the iipsrv process owner is able to access and read the images!
+
+### Output Images
+iipsrv can transcode input images in TIFF or JPEG2000 to JPEG, PNG or WebP format. See the API documentation for details on how to use iipsrv: https://iipimage.sourceforge.io/documentation/protocol
 
 
 
 DEBUGGING
 ---------
+Basic debugging can be carried out by simply using the server logs. Verbose logging can be obtained by increasing the VERBOSITY startup variable. Implemented levels of verbosity range from 0 (no logging) to 6 (maximum amount of logging). The pre-processor defines KAKADU_DEBUG and OPENJPEG_DEBUG can additionally be set at compile time to generate additional detailed logging from these particular decoders.
 
-Basic debugging can be carried out by simply using the server logs. Verbose logging can be obtained
-by increasing the VERBOSITY startup variable. Implemented levels of verbosity range from 0 (no logging)
-to 6 (maximum amount of logging). The pre-processor defines KAKADU_DEBUG and OPENJPEG_DEBUG can
-additionally be set at compile time to generate additional detailed logging from these particular decoders.
-
-It is also possible to test iipsrv without the use of FCGI or a web server. In this case, you will need to
-compile iipsrv with DEBUG defined for the pre-processor. This can be done during the ./configure stage before
-building using make either manually by setting adding -DDEBUG to CXXFLAGS or automatically through the
---enable-debug-mode option:
+It is also possible to test iipsrv without the use of FCGI or a web server. In this case, you will need to compile iipsrv with DEBUG defined for the pre-processor. This can be done during the ./configure stage before building using make either manually by setting adding -DDEBUG to CXXFLAGS or automatically through the --enable-debug-mode option:
 
     ./configure --enable-debug-mode
     make
 
-The resulting binary can be started on the command line and will accept any supported imaging protocol requests
-(IIP, IIIF, Deepzoom or Zoomify) without any HTTP prefix or domain name (e.g. FIF=test.tif&WID=500&CVT=JPEG) as
-standard input on the command line and output the image or data to the file "iipsrv.debug" in the same directory.
-Successive requests will replace the contents of iipsrv.debug with the output of the new request. For example:
+The resulting binary can be started on the command line and will accept any supported imaging protocol requests (IIP, IIIF, Deepzoom or Zoomify) without any HTTP prefix or domain name (e.g. FIF=test.tif&WID=500&CVT=JPEG) as standard input on the command line and output the image or data to the file "iipsrv.debug" in the same directory. Successive requests will replace the contents of iipsrv.debug with the output of the new request. For example:
 
     % ./src/iipsrv.fcgi
     FIF=test.tif&WID=500&CVT=JPEG
     IIIF=/test.tif/full/500,/0/default.jpg
     FIF=test.tif&WID=600&ROT=90&&CVT=PNG
 
-On Linux/Unix based systems, it's also possible to use pipes or redirection to send a list of requests within a file
-with iipsrv automatically terminating at the end of the list:
+On Linux/Unix based systems, it's also possible to use pipes or redirection to send a list of requests within a file with iipsrv automatically terminating at the end of the list:
 
     iipsrv.fcgi < request_list.txt
 
-Debugging using memory testing tools, such as valgrind (https://valgrind.org/), can be performed by starting
-iipsrv on the command-line through the testing tool. For example:
+Debugging using memory testing tools, such as valgrind (https://valgrind.org/), can be performed by starting iipsrv on the command-line through the testing tool. For example:
 
     valgrind iipsrv.fcgi --bind 0.0.0.0:9000
 
-This can work in conjunction with debugging mode or together with a web server in normal FCGI-mode. In this case
-the web server must be setup to proxy forward FCGI requests to the address and port specified when starting iipsrv.
+This can work in conjunction with debugging mode or together with a web server in normal FCGI-mode. In this case the web server must be setup to proxy forward FCGI requests to the address and port specified when starting iipsrv.
 
 
 
diff --git a/docker/README b/docker/README
index d897a6bc..0fba5cb0 100644
--- a/docker/README
+++ b/docker/README
@@ -63,7 +63,7 @@ Using the Container
 
 Once started, it's possible to connect to the container and make requests using any of iipsrv's supported APIs.
 The container provides a standard iipsrv service at /fcgi-bin/iipsrv.fcgi as well as an IIIF endpoint at
-/iiif/. 
+/iiif/.
 
 For example, to make an IIIF request to obtain an image (image.tif) resized to 500px in width: