Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Core configuration

ParameterTypeImportanceExplanationDefault valuePossible values
CORE_URL

Status
colourRed
titleURL

Status
colourRed
titleMandatory

the URL dedicated to the Core of Cytominelocalhost-coreA valid URL
SENDER_EMAIL_SMTP_HOST

Status
colourGreen
titleConfig

Status
colourYellow
titleIN PROD

email params of the sending account

SENDER_EMIAL_SMTP_PORT

Status
colourGreen
titleConfig

Status
colourYellow
titleIN PROD

email params of the sending account

SENDER_EMAIL

Status
colourGreen
titleConfig

Status
colourYellow
titleIN PROD

email params of the sending account

SENDER_EMAIL_PASS

Status
colourGreen
titleConfig

Status
colourYellow
titleIN PROD

email params of the sending account--
CORE_DEVELOPMENT

Status
colourBlue
titlePlugin

Status
titleADVANCED

Set to true to avoid core running in a Docker containerfalsetrue, false

IMS configuration

ParameterTypeImportanceExplanationDefault valuePossible values
IMS_URL1

Status
colourRed
titleURL

Status
colourRed
titleMandatory

the URL dedicated to the first image serverlocalhost-imsA valid URL
UPLOAD_URL

Status
colourRed
titleURL

Status
colourRed
titleMandatory

the URL for image uploadlocalhost-uploadA valid URL
IMS_STORAGE_PATH

Status
colourYellow
titlePATH

Status
colourRed
titleMandatory

A pre-existing filesystem path to store images (withtout ending /)/data/images
IMS_BUFFER_PATH

Status
colourYellow
titlePATH

Status
colourRed
titleMandatory

A pre-existing filesystem path to IMS buffer (without ending /)/data/_buffer
FAST_DATA_PATH

Status
colourYellow
titlePATH

Status
colourRed
titleMandatory

Same as IMS_STORAGE_PATH or a pre-existing filesystem path to store multidimensional images (withtout ending /)/data/images
IMS_DEVELOPMENT

Status
colourBlue
titlePlugin

Status
titleADVANCED

Set to true to avoid IMS running in a Docker containerfalsetrue, false
IIP_OFF_URL

Status
colourRed
titleURL

Status
titleADVANCED

the URL of Cytomine IIP serverlocalhost-iip-cytoA valid URL (can be local)
IIP_CYTO_URL

Status
colourRed
titleURL

Status
titleADVANCED

the URL of Cytomine IIP serverlocalhost-iip-cytoA valid URL (can be local)
MEMCACHED_PASS

Status
colourGreen
titleConfig

Status
titleADVANCED


--
NB_IIP_PROCESS

Status
colourGreen
titleConfig

Status
titleADVANCED

Number of simultaneous IIP processes10

Number > 1

Backup plugin configuration

ParameterTypeImportanceExplanationDefault valuePossible values
BACKUP_ENABLED

Status
colourBlue
titlePlugin

Status
colourRed
titleMandatory

To enable an automatic daily backup, set to truefalsetrue, false
RECEIVER_EMAIL

Status
colourGreen
titleConfig

Status
colourBlue
titleIF PLUGIN


--
BACKUP_PATH

Status
colourYellow
titlePATH

Status
colourBlue
titleIF PLUGIN

A pre-existing filesystem path to store auto backup

Retrieval plugin configuration

ParameterTypeImportanceExplanationDefault valuePossible values
RETRIEVAL_ENABLED

Status
colourBlue
titlePlugin

Status
colourRed
titleMandatory


truetrue, false
RETRIEVAL_URL

Status
colourRed
titleURL

Status
colourBlue
titleIF PLUGIN

the URL of retrieval serverlocalhost--retrievalA valid URL
RETRIEVAL_PATH

Status
colourYellow
titlePATH

Status
colourBlue
titleIF PLUGIN

A pre-existing filesytem path to store retrieval data (without ending /)

RETRIEVAL_PASSWORD

Status
colourGreen
titleConfig

Status
titleADVANCED


--
RETRIEVAL_ENGINE

Status
colourGreen
titleConfig

Status
titleADVANCED


redisredis, memory

Bioformat plugin configuration

ParameterTypeImportanceExplanationDefault valuePossible values
BIOFORMAT_ENABLED

Status
colourBlue
titlePlugin

Status
colourRed
titleMandatory

Enable the bioformat convertor to support more formats (VSI, OME-TIFF,...)truetrue, false

Native JPEG2000 support plugin configuration

ParameterTypeImportanceExplanationDefault valuePossible values
IIP_JP2_ENABLED

Status
colourBlue
titlePlugin

Status
colourRed
titleMandatory


truetrue, false
IIP_JP2_URL

Status
colourRed
titleURL

Status
titleADVANCED

the URL of IIP server for JPEG2000localhost-iip-jp2000A valid URL (can be local)

IRIS plugin configuration

ParameterTypeImportanceExplanationDefault valuePossible values
IRIS_ENABLED

Status
colourBlue
titlePlugin

Status
colourRed
titleMandatory


falsetrue, false
IRIS_URL

Status
colourRed
titleURL

Status
colourBlue
titleIF PLUGIN


localhost-irisA valid URL
IRIS_ADMIN_NAME

Status
colourGreen
titleConfig

Status
colourBlue
titleIF PLUGIN


--
IRIS_ADMIN_ORGANIZATION_NAME

Status
colourGreen
titleConfig

Status
colourBlue
titleIF PLUGIN


--
IRIS_ADMIN_EMAIL

Status
colourGreen
titleConfig

Status
colourBlue
titleIF PLUGIN

-
email address where user will ask permissions for IRIS projects  -
IRIS_ID

Status
colourGreen
titleConfig

Status
titleADVANCED

Useful if we are admin of multiple IRIS versionLOCAL_CYTOMINE_IRIS-

Software plugin configuration

ParameterTypeImportanceExplanationDefault valuePossible values
SOFTWARE_ENABLED

Status
colourBlue
titlePlugin

Status
colourRed
titleMandatory


truetrue, false
SOFTWARE_CODE_PATH

Status
colourYellow
titlePATH

Status
colourBlue
titleIF PLUGIN




SOFTWARE_DOCKER_IMAGES_PATH

Status
colourYellow
titlePATH

Status
colourBlue
titleIF PLUGIN




JOB_PATH

Status
colourYellow
titlePATH

Status
colourBlue
titleIF PLUGIN




SERVER_SSHKEYS_PATH

Status
colourYellow
titlePATH

Status
colourBlue
titleIF PLUGIN




RABBITMQ_LOGIN

Status
colourGreen
titleConfig

Status
titleADVANCED


router-
RABBITMQ_PASSWORD

Status
colourGreen
titleConfig

Status
titleADVANCED


router-