Skip to content

Visualdoop/config.sh ​

Mandatory Configuration ​

Name

Type

Description

JAVA_HOME

String

The path to your java environment.

VISUALDOOP_DATA

String

The local path to the data written and used by the Developer Console. The user executing it must have all rights to this path.

If you choose to store your console data inside an S3 bucket, this parameter is the base object in which the data will be stored.

E.g: If you want to store my data in this path : s3://mybucket/path/to/dev/console, your VISUALDOOP_DATA parameter will be path/to/dev/console.

Developer Console data are not data you should use with Indexima and business intelligence tools. It is only data used by the Developer Console such as projects, users, saved queries, etc.

VISUALDOOP_WEB_PORT

Integer

The number of ports used to connect to the Developer Console via your internet browser.

VISUALDOOP_LOGIN

String

The authentication mode you want:

  • BASIC - Default mode. Local authentication with user/password.

  • LDAP - Enable LDAP authentication.

Advanced Configuration ​

LDAP (Deprecated: replaced by (2022.3) Visualdoop/ldap.properties) ​

NameTypeDescription
VISUALDOOP_LDAP_URLStringThe location of your LDAP server.
VISUALDOOP_LDAP_USER_DN_PATTERNStringThe DN pattern related to the LDAP server
VISUALDOOP_LDAP_DOMAINStringDomaine Name

KNOX ​

NameTypeDescription
VISUALDOOP_KNOX_HOST_RETRIEVALBooleanTRUE if you connect to Indexima through a Knox gateway

SSL ​

NameTypeDescription
VISUALDOOP_SSLBooleanTRUE: if you want to connect to the web console through an HTTPS encrypted connection
VISUALDOOP_WEB_PORT_SSLIntegerPort number for the HTTPS connection to the web console. Used only if VISUALDOOP_SSL is true
VISUALDOOP_SSL_KEYSTORE_LOCATIONStringAbsolute path to the java Keystore used for TLS/SSL encryption. Used only if VISUALDOOP_SSL is true
VISUALDOOP_SSL_KEYSTORE_PASSWORDStringPassphrase of the Keystore used for TLS/SSL encryption. Used only if VISUALDOOP_SSL is true

VisualDoop Data storage on s3 ​

Name

Type

Description

VISUALDOOP_STORE

String

If you want to store your dev console data on Amazon S3, Google Cloud Storage, or Azure Data Lake Storage, set this parameter to the desired value.

Possibles values are: S3, GS, ADLS respectively.

VISUALDOOP_BUCKET

String

The name of the bucket you want to use to store your Visualdoop data.

E.g: s3://mybucket/path/to/dev/console, VISUALDOOP_BUCKET will be mybucket

This parameter is only used if VISUALDOOP_STORE is set to S3 or GS

VISUALDOOP_S3_ACCESS_KEY

String

Access key to read / write on S3 filesystem.
The account associated with this access key must have read and write rights on the bucket previously configured.

VISUALDOOP_S3_SECRET_KEY

String

Secret key to read / write on S3 filesystem.
The account associated with this secret key must have read and write rights on the bucket previously configured.

VISUALDOOP_S3_CERT_CHECK

boolean

Enable validation of server certificates when using the HTTPS protocol. Default is false.

VISUALDOOP_S3_COMPATIBLE

boolean

Use Compatible mode for S3 protocol. Default is false.

VISUALDOOP_S3_REGION

String

Configure the region with which the SDK should communicate.

VISUALDOOP_S3_ENDPOINT

String

Sets the endpoint configuration (service endpoint & signing region) to be used for requests.

Admin Users ​

NameTypeDescription
VISUALDOOP_ADMINStringDefine the admin users (comma separated). Could be LDAP users.

Miscellaneous ​

NameTypeDescription
VISUALDOOP_HOSTStringThe host to which Developer Console must connect to in order to run. Unless you use an unusual and specific infrastructure, this value must be set at 0.0.0.0 when Developer Console is not installed on your personal computer.
PROJECT_MODEbooleanDisplays menu items related to the project mode (original model)
CLUSTER_MODEbooleanDisplays menu items related to the cluster mode (new model) - Part 1
CLUSTER_ONLYbooleanDisplays menu items related to the cluster mode (new model)  - Part 2