Loading...
 

Installation configuration variables

Detailed explanation of configuration options

The following tables explain the variables used to configure your installation.

For a basic, simple installation, you need to configure only the mandatory variables.

 

URLS

Please use different URLs that are not already present in your /etc/hosts file to avoid conflicts.

VariableImportanceExplanationExample value
CORE_URLMandatorythe URL dedicated to the Core of Cytominelocalhost-core
IMS_URL'sMandatorythe URL(s) dedicated to one or more image serverlocalhost-ims
UPLOAD_URLMandatorythe URL for image uploadlocalhost-upload
IIP_OFF_URLAdvancedthe URL of IIP serverlocalhost-iip-base
IIP_CYTO_URLAdvancedthe URL of Cytomine custom IIP serverlocalhost-iip-cyto


Storage Paths

You have to choose existing paths on an available filesystem where image files will be stored. Please note you have to specify paths without a "/" at the end (e.g. "/data", not "/data/").

VariableImportanceExplanationExample value
IMS_STORAGEMandatoryA pre-existing filesystem path to store images (withtout ending /)/data (but not /data/)
IMS_BUFFER_PATHMandatoryA pre-existing filesystem path to IMS buffer (without ending /)/data/buffer (but not /data/buffer/)
ALGO_PATHMandatoryA pre-existing filesystem path to store Cytomine softwares (without ending /)/data/algo
BACKUP_PATHIf backupA pre-existing filesystem path to store auto backup    

 

Email

VariableImportanceExplanation
SENDER_EMAILOptional to test the app, mandatory otherwiseemail params of the sending account    
SENDER_EMAIL_PASSOptional to test the app, mandatory otherwiseemail params of the sending account    
SENDER_EMAIL_SMTP_PORTOptional to test the app, mandatory otherwiseemail params of the sending account    
SENDER_EMAIL_SMTP_HOSTOptional to test the app, mandatory otherwiseemail params of the sending account    
RECEIVER_EMAILIf backupemail adress of the backup reports receiver    

 

Other advanced configuration

RABBITMQ_LOGIN    Advanced         
RABBITMQ_PASSWORDAdvanced
NB_IIP_PROCESSAdvancedNumber of simultaneous IIP processes20
MEMCACHED_PASSAdvanced         
BIOFORMAT_ENABLEDAdvancedEnable the bioformat convertor to support more formats (VSI, OME-TIFF,...)    
BIOFORMAT_ALIASAdvanced         
BIOFORMAT_PORTAdvanced         

Remark :
Since the Version 2.0.0 of Cytomine, the retrieval and iris components are no more officially supported. If you want to install the Version 1, you need to add these variables too

VariableImportanceExplanationExample value
RETRIEVAL_URLAdvancedthe URL of retrieval serverlocalhost-retrieval
RETRIEVAL_PATHMandatoryA pre-existing filesytem path to store retrieval data (without ending /)/data/thumb
RETRIEVAL_ENGINEAdvancedmemory, redisredis
RETRIEVAL_PASSWDAdvanced
IRIS_URLAdvanced
IRIS_IDAdvancedUsefull if we are admin of multiple IRIS version
IRIS_ADMIN_NAMEAdvanced
IRIS_ADMIN_ORGANIZATION_NAMEAdvanced
IRIS_ADMIN_EMAILAdvancedThe email adress where user will ask permissions for IRIS projects