The Zegami Server and CLI are both configured via a configuration file called settings.conf which is located at C:\Program Files\Zegami\Lib\site-packages\zegami\conf\settings.conf on Windows and /opt/zegami/conf/settings.conf on Linux.

Settings.conf is responsible for a range of server options and is divided up into groups of configuration items so that it is simpler to read. Configuration section headings are marked by the section name in square brackets: [ and ].

[core]

General Zegami settings.

debug: Boolean

A True or False value indicating that the server should be run in debug mode.

formats: List of strings

A comma separated list of allowed image file formats.

collections: String

The full path to the directory where Zegami will store all collection images.

depth: Number

Used by the image processing module. This is the Deep Zoom level where the atlas texture map stops and the individual pyramids begin.

datapath: String

The full path to the directory where Zegami will store all collection data. In most cases it is recommended that this be the same as the collections path.

cores: Number

The count of CPU cores to use when processing images.

[logging]

Server logging settings.

logLevel: Number

Zegami provides fine grained control over the amount of logging that is produced. In most cases level 30 will provide enough information for general use. In situations where more detail is required for debugging purposes this level can be adjusted. The available levels are: 40 - Display error messages and critical messages 30 - Display warning, error and critical messages (Recommended) 20 - Display info, warning, error and critical messages (Zegami debug level) 10 - Display debug, info, warning, error and critical messages (all module debug level) * 0 - Do not display any messages

directory: String

The full path to the directory where the logs will be kept

days: Number

The number of days to keep rotated logs

host: IP Address

The host name of the logging server

port: Number

The port number of the logging server

[auth]

Authentication plugin settings.

plugin: String

The name of the plugin to use for Authentication. The available options are: NoAuth - No authentication LocalAuth - Uses the local MongoDb instance to store user details * LDAPAuth - Authenticates users against an LDAP server

anonymous: Boolean

Enables/disables anonymous access to collections - only if the currnet licence allows it

[image]

Image plugin settings. The image plugin is responsible for loading and processing images.

plugin: String

The name of the plugin to use for image processing. The available options are: Vips - For fast performance on Linux only. Has stability issues and may fail to process a collection. Pillow - Pythons native image handling libraries.

[destination]

destination plugin settings. The destination plugin is responsible for storing all collection related files.

plugin: String

The name of the plugin to use for storing collection files. The default (and only option) is: FilesystemImageDestination

[server]

Web server settings

host: IP Address or host name

The IP Address or host name of the server. (Only applicable it the Flask server which is used on windows installs and web development).

port: Number

The port which the web server is running on (Only applicable it the Flask server which is used on windows installs and web development).

[database]

MongoDB database connection details. By default is set to work with the locally installed instance, but this can be overridden to support a remote instance.

host: IP Address or host name

The IP Address or host name of the MongoDB instance (default is localhost).

port: Number

The port which the MongoDB instance is running on (default is 27017).