This version of the manual refers to an earlier version of the software.



Cantaloupe obtains its configuration from a .properties file. A sample configuration file, called, is included in the distribution archive. It is recommended to make a copy of this file and use the copy as your primary configuration file.

To tell the image server where the configuration file is located, supply the -Dcantaloupe.config VM option, pointing to an absolute or relative path to the file. The file can be located anywhere, and named anything. (See Getting Started for examples.)

Live Changes

The configuration file will be automatically reloaded within a few seconds of a change. Changes to most keys take effect immediately, but some require a restart; see the sample configuration file for documentation of which.

Remote Changes

The configuration can be updated remotely via the REST API. When a change is received, it will be activated immediately and written out to the configuration file, if it is writable.