Configuration file datafari.properties

Owned by Olivier Tavard
Last updated: 30 Sept, 2024
4 min read

This is the main configuration file of Datafari. It is located into $DATAFARI_HOME/tomcat/conf

Property name

Applies for

Mandatory

Possible values

Explanations

Property name

Applies for

Mandatory

Possible values

Explanations

INSTALLER_TYPE

ALL TYPES

YES

interactive

machine

If set to interactive, the script will ask questions to the user to fill the datafari.properties file

NODETYPE

ALL TYPES

YES

monoserver

main

solr

mcf

 

NODEHOST

ALL TYPES

YES

 

Enter the IP of the server

SOLRNUMSHARDS

SOLR

MAIN

YES

 

Enther the number of shards you want for your Solr collection

SOLRHOSTS

MAIN

SOLR

MCF

YES

 

Specify the ZK hosts with the port and separated with commas. For exemple: 127.0.0.1:2181,192.168.0.1:2181 (automatically filled for monoserver)

SOLRMAINCOLLECTION

 

YES

 

Enter the name of the Solr collection

TEMPADMINPASSORD

MONOSERVER

MAIN

MCF

YES

 

Enter the password for Datafari

TEMPPGSQLPASSWORD

MONOSERVER

MAIN

MCF

YES

 

Enter the password for PostgreSQL

MCFPASSWORD

MONOSERVER

MCF

YES

 

Enter the password for MCF

POSTGRESQL_EXTERNAL

MONOSERVER

MAIN

MCF

YES

true/false

Indicate if Datafari uses an externalized PostgreSQL database

POSTGRESQL_HOSTNAME

MONOSERVER

MAIN

MCF

only if POSTGRESQL_EXTERNAL = true

 

 

POSTGRESQL_DATABASE

MONOSERVER

MAIN

MCF

only if POSTGRESQL_EXTERNAL = true

 

 

POSTGRESQL_USERNAME

MONOSERVER

MAIN

MCF

only if POSTGRESQL_EXTERNAL = true

 

 

POSTGRESQL_PORT

MONOSERVER

MAIN

MCF

only if POSTGRESQL_EXTERNAL = true

 

 

SSD_DISK

MONOSERVER

MAIN

MCF

YES

 

indicate if the disk is SSD or not

solrNodesNumber

MAIN

YES

 

Enter the number of Solr servers that you have

mcfNodesNumber

MAIN

YES

 

Enter the number of MCF servers you have (enter 0 if none)

MCFHOSTS

MAIN

YES if mcfNodesNumber > 0

 

Enter the IP of the MCF servers you have (enter only if you have one or more MCF servers)

currentMCFNumber

MCF

YES

 

Enther the number of the current MCF server you install

currentSolrNumber

SOLR

YES

 

Enther the number of the current Solr server you install

MAINNODEHOST

SOLR

YES

 

Enter the IP of the main node host

replicationFactor

MAIN

YES

 

indicate the replication factor of the Solr collection (ie indicate if the shards are present only one time or if they are replicated)

sessionTimeoutUnauthenticated

MONOSERVER

MAIN

MCF

YES

 

60 represents the time in second a session remains active before being logged out by Tomcat.

sessionTimeoutAuthenticated

MONOSERVER

MAIN

MCF

YES

 

1500 represents the time in second a session remains active before being logged out by Tomcat.

maxConcurrentSessions

MONOSERVER

MAIN

MCF

YES

 

Number maximum of sessions

IS_LIKES_AND_FAVORITES_ENABLED

MONOSERVER

MAIN

 

YES

 

Activate or not the likes and favorites

ontologyLanguageSelection

MONOSERVER

MAIN

MCF

YES

 

 

ontologyChildrenLabels

MONOSERVER

MAIN

MCF

YES

 

 

ontologyParentsLabels

MONOSERVER

MAIN

MCF

YES

 

 

ontologyEnabled

MONOSERVER

MAIN

MCF

YES

 

 

ontologyNodeLabels

MONOSERVER

MAIN

MCF

YES

 

 

OCR

MONOSERVER

MAIN

MCF

YES

 

Indicates if OCR is activated

emailLicense

MONOSERVER

MAIN

MCF

YES

 

email address to contact to get licenses of Datafari

TIKASERVER

MONOSERVER

MAIN

MCF

YES

 

indicates if there is a Tika server activated

TIKASERVER_ANNOTATOR

 

 

 

indicates if there is a Tika server for annotators activated

TIKASERVER_OCR

 

 

 

indicates if there is a Tika server for OCR activated

userAllowedHandlers

MONOSERVER

MAIN

MCF

YES

 

List of handlers allowed into Datafari

ALLOWLOCALFILEREADING

MONOSERVER

MAIN

MCF

YES

 

Indicates if it is possible to access local files

IP_SSH_ADMIN

 

 

 

Indicates if there is a SSH IP admin address different than the IP of the server

SSH_PORT

ALL_TYPES

Yes

 

Starting from Datafari 5.4.1.

Default value is 22

remote_timeout

 

 

 

The timeout of SSH commands into multiservers mode

AnalyticsActivation

ALL TYPES

No

true

false (default)

If you want to activate the Analytics stack on the main/monoserver and Logstash on the other servers

 

 

 

 

 

MONIT_STATE

 

 

 

Indicates if Monit is activated or not

log_retention

ALL TYPES

Yes if you use the monitoring scripts

 

Indicates the number of days that we retain the logs

 

 

 

 

 

ALERT_STATE

 

 

 

Indicates if the Alerts global monitoring script was executed and the alerts system configured

 

 

 

 

 

email_servername

ALL TYPES

Yes if you use the monitoring and alert scripts

 

the name of the server to monitor

smtp_authentication

 

 

 

indicates if there is a smtp authentication or not

smtp_username

 

 

 

username of the smtp account

smtp_password

ALL TYPES

Yes if you use the monitoring and alert scripts

 

password of the smtp account

smtp_address

ALL TYPES

Yes if you use the monitoring and alert scripts

 

the domain name of the smtp server

smtp_port

ALL TYPES

Yes if you use the monitoring and alert scripts

 

the port of the smtp server

smtp_tls

 

 

 

indicates if tls is activated or not

smtp_starttls

 

 

 

indicates if there is starttls or not

email_recipient

 

 

 

the email of the recipient of the alerts

email_sender

 

 

 

the email of the sender of the alerts

 

 

 

 

 

iptables_activation

 

 

 

indicates if iptables rules are applied or not

 

 

 

 

 

global_backup_folder

 

 

 

the path of the backup folder

global_restore_folder

 

 

 

the path of the restore folder

backup_cassandra_retention_time

 

 

 

number of days of retention of Cassandra logs

backup_mcf_retention_time

 

 

 

number of days of retention of MCF logs

backup_configuration_retention_time

 

 

 

number of days of retention of Cassandra logs

backup_solr_retention_time

 

 

 

number of days of retention of Cassandra logs

 

 

 

 

 

certificate_folder

 

 

 

folder of the SSL certificate

certificate_file

 

 

 

the filename of the SSL certificate (generally use the same thing than full_certificate_file)

full_certificate_file

 

 

 

the entire certificate chain in a single file (typically fullchain.pem = cert.pem + chain.pem)

private_key_certificate

 

 

 

the private key for your certificate

 

 

 

 

 

python_version

 

 

 

indicates the version of Datafari. Starting from Datafari 6, not needed anymore

 

 

 

 

 

email_feedbacks

 

 

 

The email that will be used to send feedback about Datafari

email_dpo

 

 

 

The email of the Data Protection Officer (DPO) regarding RGPD questions

email_bugs

 

 

 

The email that will be used to send bugs questions oe reports about Datafari

 

 

 

 

 

ENABLE_MONITORING_TIMER

ALL_TYPES

No

true

false (default)

Starting from Datafari 6.1.

If you want to activate Monitoring Timers

Â