ZooNavigator Docs logo ZooNavigator Docs

ZooNavigator’s Docker images are configured using environment variables.


Server


API_HTTP_PORT

default: 8000, available since: 0.5.0, replaces: SERVER_HTTP_PORT
Tells the HTTP server which port to bind to.
To disable HTTP set this variable to disabled.

API_HTTPS_PORT

available since: 0.5.0
If set, HTTPS server will bind to this port.

API_SSL_KEYSTORE_PATH

available since: 0.5.0
The path to the keystore containing the private key and certificate, if not provided generates a keystore for you.

API_SSL_KEYSTORE_PASSWORD

available since: 0.5.0
The password to the keystore, defaults to a blank password.

API_SSL_KEYSTORE_TYPE

default: JKS, available since: 0.5.0
The key store type.

API_SESSION_TIMEOUT_MILLIS

default: 900000, available since: 0.5.0, replaces: SESSION_TTL_MILLIS
Sets session inactivity timeout for users.
This value is in milliseconds.

API_SECRET

available since: 0.5.0, replaces: APP_SECRET
Secret key for Play Framework - used for signing session cookies and CSRF tokens.
Defaults to 64 random characters generated from /dev/urandom.

Java


JAVA_OPTS

available since: 0.5.0
Custom Java arguments.

JAVA_XMS

available since: 0.5.0, replaces: JVM_XMS
Sets initial Java heap size.
This value is in bytes if no unit is specified.

JAVA_XMX

available since: 0.5.0, replaces: JVM_XMX
Sets maximum Java heap size.
This value is in bytes if no unit is specified.

JAVA_JAAS_LOGIN_CONFIG

available since: 0.5.0
Path to JAAS login configuration file to use.

JAVA_KRB5_DEBUG

available since: 0.5.0
If set to true, enables debugging mode and detailed logging for Kerberos.

JAVA_KRB5_REALM

available since: 0.5.0
Sets the default Kerberos realm.

JAVA_KRB5_KDC

available since: 0.5.0
Sets the default Kerberos KDC.

ZooKeeper client


ZK_CLIENT_TIMEOUT_MILLIS

default: 5000, available since: 0.5.0, replaces: ZK_CLIENT_TTL_MILLIS
Sets inactivity timeout for ZooKeeper client. If user doesn’t make any request during this period ZooKeeper connection will be closed and recreated for the future request if any.
Note that user does not get logged out unlike in event of session timeout.
This value is in milliseconds.

ZK_CONNECT_TIMEOUT_MILLIS

default: 5000
Sets timeout for attempt to establish connection with ZooKeeper.
This value is in milliseconds.

ZK_SASL_CLIENT

default: true, available since: 0.5.0
Set the value to false to disable SASL authentication.

ZK_SASL_CLIENT_CONFIG

default: Client, available since: 0.5.0
Specifies the context key in the JAAS login file.

ZK_SASL_CLIENT_USERNAME

default: zookeeper, available since: 0.5.0
Specifies the primary part of the server principal. Learn more here.

ZK_SERVER_REALM

available since: 0.5.0
Realm part of the server principal.
By default it is the client principal realm.

ZK_CLIENT_SECURE

available since: 0.5.0
If you want to connect to the server secure client port, you need to set this property to true. This will connect to server using SSL with specified credentials.
Note that it requires using the Netty client.

ZK_CLIENT_CNXN_SOCKET

default: org.apache.zookeeper.ClientCnxnSocketNIO, available since: 0.5.0
Specifies which ClientCnxnSocket to be used. If you want to connect to server’s secure client port, you need to set this property to :org.apache.zookeeper.ClientCnxnSocketNetty.

ZK_SSL_KEYSTORE_PATH

available since: 0.5.0
Specifies the file path to a JKS containing the local credentials to be used for SSL connections.

ZK_SSL_KEYSTORE_PASSWORD

available since: 0.5.0
Specifies the password to a JKS containing the local credentials to be used for SSL connections.

ZK_SSL_TRUSTSTORE_PATH

available since: 0.5.0
Specifies the file path to a JKS containing the remote credentials to be used for SSL connections.

ZK_SSL_TRUSTSTORE_PASSWORD

available since: 0.5.0
Specifies the password to a JKS containing the remote credentials to be used for SSL connections.