cogapp/cantaloupe repository overview

⁠Cantaloupe

⁠Summary

Provides a Cantaloupe image server with tooling for all available image formats.

⁠Environment variables

⁠User/Group ID

The Cantaloupe process and all folder are run by/owned by the cantaloupe user. The user and group IDs for the cantaloupe user can be set by assigning values to the CANTALOUPE_UID, CANTALOUPE_GID.

These default to 1000/1000 respectively.

⁠Java Options

Runtime Java opts can be set with the JAVA_OPTS environment variable.

This defaults to -Xmx8g

⁠Cantaloupe configuration

By default, the Cantaloupe configuration is controlled by environment variables written as part of the ENTRYPOINT script, and templated using confd. If for some reason you'd prefer to manually add a config file, then you can mount it to /cantaloupe/cantaloupe.custom.properties in your container and set the CONFIG_FILENAME property to point to /cantaloupe/cantaloupe.custom.properties.

This defaults to cantaloupe.properties, which is the default templated file.

⁠Configuration via environment variables

Every configurable property has an environment variable equivalent that follows the a convention whereby the Cantaloupe configuration keys are transofrmed to uppercase, and any full stops or other punctiation is transformed to an underscore.

For example, to set the cache.server.source.ttl_seconds property, you would assign a value to the CACHE_SERVER_SOURCE_TTL_SECONDS environment variable.

⁠Example Docker Compose file

The following will allow images to be retrieved via Cantaloupe on http://127.0.0.1:8182⁠, with the admin URL available under /admin with the password admin.

version: "3"

services:
  cantaloupe:
    image: cogapp/cantaloupe:5-latest
    ports:
      - "8182:8182"
    environment:
      ENDPOINT_ADMIN_ENABLED: "true"
      ENDPOINT_ADMIN_SECRET: "admin"
      CACHE_SERVER_DERIVATIVE_ENABLED: "true"
      CACHE_SERVER_DERIVATIVE: "FilesystemCache"

    volumes:
      - ./path/to/images/:/cantaloupe/images/