Skip to content

Latest commit

 

History

History
2898 lines (2174 loc) · 107 KB

environment-variables.md

File metadata and controls

2898 lines (2174 loc) · 107 KB
Raw

Environment variables

List

ADMINER_DEFAULT_SERVER

  1. Synopsis:
    1. The default hostname/ip-address of the database server.
    2. See Adminer on DockerHub
  2. Where used

AWS_ACCESS_KEY_ID

  1. Synopsis:
    1. The access key for your AWS account.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Examples:
    1. See How to set AWS environment variables
  3. Where used

AWS_CA_BUNDLE

  1. Synopsis:
    1. The path to a custom certificate bundle to use when establishing SSL/TLS connections.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_CONFIG_FILE

  1. Synopsis:
    1. The location of the config file.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_DATA_PATH

  1. Synopsis:
    1. A list of additional directories to check when loading botocore data.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_DEFAULT_REGION

  1. Synopsis:
    1. The default AWS Region to use.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Examples:
    1. us-east-1
    2. us-west-2
    3. See How to set AWS environment variables
  3. Where used

AWS_MAX_ATTEMPTS

  1. Synopsis:
    1. The total number of attempts made for a single request.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_METADATA_SERVICE_NUM_ATTEMPTS

  1. Synopsis:
    1. Number of attempts to retrieve credentials on an Amazon EC2 instance.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Values:
    • Default: 1
  3. Where used

AWS_METADATA_SERVICE_TIMEOUT

  1. Synopsis:
    1. The number of seconds before a connection to the instance metadata service should time out.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_PROFILE

  1. Synopsis:
    1. The default profile to use, if any.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_RETRY_MODE

  1. Synopsis:
    1. Specifies the types of retries the SDK will use.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

AWS_SECRET_ACCESS_KEY

  1. Synopsis:
    1. The secret key for your AWS account.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Examples:
    1. See How to set AWS environment variables
  3. Where used

AWS_SESSION_TOKEN

  1. Synopsis:
    1. The session key for your AWS account.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Examples:
    1. See How to set AWS environment variables
  3. Where used

AWS_SHARED_CREDENTIALS_FILE

  1. Synopsis:
    1. The location of the shared credentials file.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Values:
    • Default: ~/.aws/credentials
  3. Where used

AWS_STS_REGIONAL_ENDPOINTS

  1. Synopsis:
    1. Sets AWS STS endpoint resolution logic.
    2. When used in python programs, see Boto3 Configuration, Using environment variables.
  2. Where used

DATABASE_DATABASE

  1. Synopsis:

    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. The name of the database holding the Senzing G2 model.

  2. Values:

    • Default: none
    • Usually: G2

  3. Examples:

    1. Using G2 as the database:

      export DATABASE_DATABASE=G2

  4. Where used

DATABASE_HOST

  1. Synopsis:

    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. A hostname, IP address, or symbolic name of the database service.

  2. Examples:

    1. Using an IP address:

      export DATABASE_HOST=10.1.1.17

    2. Using a hostname:

      export DATABASE_HOST=host.example.com

  3. Where used

DATABASE_PASSWORD

  1. Synopsis:

    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. The password for the database user, DATABASE_USERNAME.

  2. Examples:

    1. Using password of "my;password!":

      export DATABASE_PASSWORD="my;password!"

  3. Where used

DATABASE_PORT

  1. Synopsis:

    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. The port on the machine offering the database service.

  2. Values:

    • 1433 - mssql default
    • 3306 - mysql default
    • 5432 - postresql default
    • 50000 - db2 default
    • sqlite3 has no default as it is file-based.
    • Default: none

  3. Examples:

    1. Using default port for postgresql:

      export DATABASE_PORT=5432

  4. Where used

DATABASE_PROTOCOL

  1. Synopsis:

    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. Identifies which type of database will be connected.

  2. Values:

    • db2
    • mssql
    • mysql
    • postgresql
    • sqlite3
    • Default: none

  3. Examples:

    1. PostgreSQL

      export DATABASE_PROTOCOL=postgresql

  4. Where used

DATABASE_QUERY_PARAMETERS

  1. Synopsis:
    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. Parameters passed into specific database engines.
  2. Values:
    1. See mssql
    2. See mysql
    3. See postgresql
  3. Examples:
    1. sslmode: "postgresql://username:password@host.example.com:5432/G2/?sslmode=disable"
  4. Where used

DATABASE_USERNAME

  1. Synopsis:

    1. A component of SENZING_DATABASE_URL and SENZING_TOOLS_DATABASE_URL.
    2. The name of a user authorized to work with the DATABASE_DATABASE database.

  2. Examples:

    1. Using user name of "my-user":

      export DATABASE_USERNAME="my-user"

  3. Where used

DB2_CUSTOM_DIR

  1. Synopsis:
    1. The directory containing custom scripts for ibmcom/db2 docker container. Is mounted to /var/custom.
  2. Values:
    1. Default: None
  3. Where used

DB2_DB

  1. Synopsis:
    1. The database schema name.
  2. Values:
    1. Default: "G2"
  3. Where used

DB2_DIR

  1. Synopsis:
    1. Path on local system where the database files are stored.
  2. Values:
    1. Default: None. Application dependent.
  3. Where used

DB2_PASSWORD

  1. Synopsis:
    1. Password for the database "root" username.
  2. Values:
    1. Default: "db2inst1"
  3. Where used

DB2_USERNAME

  1. Synopsis:
    1. The username for the the database "root" user.
  2. Values:
    1. Default: "db2inst1"
  3. Where used

DB2INST1_PASSWORD

  1. Synopsis:
    1. The password for the "db2inst1" user name.
  2. Values:
    1. Default: "db2inst1"
  3. Where used

DEMO_NAMESPACE

  1. Synopsis:
    1. In a Kubernetes environment, a value used for the namespace.
  2. Values:
    1. Example: "my-namespace"
  3. Where used

DEMO_PREFIX

  1. Synopsis:
    1. In a Kubernetes environment, a value prefixed used to object names.
  2. Values:
    1. Example: "my"
  3. Where used

DOCKER_APP

  1. Synopsis:
    1. The docker app command, based on the type of installation (Stand-alone or Docker CLI plugin).
    2. Docker App installation
  2. Values:
    1. "docker-app"
    2. "docker app"
    3. Default: None
  3. Where used

DOCKER_APP_PARAMETERS_FILE

  1. Synopsis:
    1. Location of file used in Docker App --parameters-file command-line option.
  2. Values:
    1. Default: None
  3. Where used

DOCKER_REGISTRY_SECRET

  1. Synopsis:
    1. In a Kubernetes environment, the name of the Kubernetes Secret for accessing the public or local Docker registry.
  2. Where used

DOCKER_REGISTRY_URL

  1. Synopsis:
    1. URL of a public or local Docker registry.
  2. Values:
    1. Example: "docker.io"
  3. Where used

G2_LICENSE_PATH

  1. Synopsis:

    1. Location of the g2.lic file on a local workstation

  2. Examples:

    1. Using Downloads directory.

      export G2_LICENSE_PATH="~/Downloads/g2.lic"

  3. Where used

GIT_ACCOUNT

  1. Where used

GIT_ACCOUNT_DIR

  1. Where used

GIT_REPOSITORY

  1. Where used

GIT_REPOSITORY_DIR

  1. Where used

GITHUB_ACTION

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_ACTIONS

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_ACTOR

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_BASE_REF

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_EVENT_NAME

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_EVENT_PATH

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_HEAD_REF

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_REF

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_REPOSITORY

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_SHA

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_WORKFLOW

  1. See GitHub Actions environment variables.
  2. Where used

GITHUB_WORKSPACE

  1. See GitHub Actions environment variables.
  2. Where used

HELM_TLS

  1. Synopsis:

    1. In a Kubernetes environment, a parameter for the kubectl command.

  2. Examples:

    1. Setting parameter.

      export HELM_TLS="--tls"

  3. Where used

HELM_VALUES_DIR

  1. Synopsis:
    1. In a Kubernetes environment, a directory holding files for use in the helm --values parameter.
  2. Where used

JUPYTER_NOTEBOOKS_PORT

  1. Synopsis:
    1. Port on localhost for senzing/jupyter.
    2. See Port 9178
  2. Values:
    1. Default: 9178
  3. Where used

JUPYTER_NOTEBOOKS_SHARED_DIR

  1. Synopsis:
    1. A directory on the localhost that is shared with the docker container as Jupyter's shared folder.
  2. Values:
    1. Default: None
  3. Where used

KUBERNETES_DIR

  1. Synopsis:
    1. In a Kubernetes environment, a directory holding files for use in the helm kubectl --filename parameter.
  2. Where used

LD_LIBRARY_PATH

  1. Where used

MSSQL_ACCEPT_EULA

  1. Synopsis:
    1. This is your acceptance of the "MICROSOFT ODBC DRIVER 17 FOR SQL SERVER" End User License Agreement (EULA). The EULA is located at https://aka.ms/odbc17eula.
    2. This is for the yum/apt package named msodbcsql17.
  2. Values:
    1. If you accept the "MICROSOFT ODBC DRIVER 17 FOR SQL SERVER" End User License Agreement (EULA), (i.e. the msodbcsql17 package) the value is "Y"
  3. Examples:
    1. See Install the Microsoft ODBC driver for SQL Server (Linux)
  4. Where used

MYSQL_DATABASE

  1. Synopsis:
    1. The database schema name.
  2. Values:
    1. Default: "G2"
  3. Where used

MYSQL_DIR

  1. Synopsis:
    1. Path on local system where the database files are stored.
  2. Values:
    1. Default: None. Application dependent.
  3. Where used

MYSQL_PASSWORD

  1. Synopsis:
    1. Password for MYSQL_USERNAME.
  2. Values:
    1. Default: "g2"
  3. Where used

MYSQL_ROOT_PASSWORD

  1. Synopsis:
    1. The password for the the database "root" user name.
  2. Values:
    1. Default: "root"
  3. Where used

MYSQL_USERNAME

  1. Synopsis:
    1. Non-root MySQL user.
  2. Values:
    1. Default: "g2"
  3. Where used

POSTGRES_DB

  1. Synopsis:
    1. The database schema name.
  2. Values:
    1. Default: "G2"
  3. Where used

POSTGRES_DIR

  1. Synopsis:
    1. Path on local system where the database files are stored.
  2. Values:
    1. Default: None. Application dependent.
  3. Where used

POSTGRES_PASSWORD

  1. Synopsis:
    1. The password for the the database "root" user name.
  2. Values:
    1. Default: "postgres"
  3. Where used

POSTGRES_USERNAME

  1. Synopsis:
    1. The username for the the database "root" user name.
  2. Values:
    1. Default: "postgres"
  3. Where used

PYTHONPATH

  1. Where used

RABBITMQ_DIR

  1. Synopsis:
    1. Path on local system where RabbitMQ files are stored.
  2. Values:
    1. Default: None. Application dependent.
  3. Where used

RABBITMQ_PASSWORD

  1. Synopsis:
    1. the password for the RabbitMQ user.
  2. Values:
    1. Default: None. Application dependent.
  3. Where used

RABBITMQ_USE_EXISTING_ENTITIES

  1. Synopsis:
    1. Should preexisting RabbitMQ exchanges, queues, and mappings be used.
  2. Values:
    1. Default: Varies
    2. True: Connect to an existing exchange or queue using the given name. Fails if the entity does not exist.
    3. False: Create the entities if they do not exist, or connect to a prexisting entity if it has the right settings. Fails if the settings passed when conncting differ from the settings on the existing entity.
  3. Where used

RABBITMQ_USERNAME

  1. Synopsis:
    1. the username for the RabbitMQ user.
  2. Values:
    1. Default: None. Application dependent.
  3. Where used

SENZING_ACCEPT_EULA

  1. Synopsis:
    1. This is your acceptance of the End User License Agreement (EULA). The EULA is located at https://senzing.com/end-user-license-agreement.
  2. Values:
    1. If you accept the Senzing End User License Agreement (EULA), the value is "I_ACCEPT_THE_SENZING_EULA"
  3. Where used

SENZING_API_RPM_DIR

  1. Synopsis:
    1. Filename for the Senzing API RPM file.
  2. Values:
    1. Format: senzingapi-M.m.P.x86_64.rpm
    2. Default: none
  3. Where used

SENZING_API_SERVER_ALLOWED_ORIGINS

  1. Synopsis:
    1. Sets the CORS Access-Control-Allow-Origin header for all Senzing API Server endpoints. There is no default value. If not specified then the Access-Control-Allow-Origin is not included with responses.
  2. Values:
    1. Default: N/A
    2. The asterisk * can be used to allow all origins as per Access-Control-Allow-Origin header specification.
  3. Where used

SENZING_API_SERVER_AUTO_REFRESH_PERIOD

  1. Synopsis:
    1. Specifies the number of milliseconds between Senzing API Server background checks to verify that the current active config is the same as the current default config, and if different reinitialize with the current default config (making it the active config). If zero is specified, then the auto-refresh is disabled and it will only occur when a requested configuration element is not found in the current active config. NOTE: This is option ignored if auto-refresh is disabled because the config was specified via the G2CONFIGFILE init option or if SENZING_API_SERVER_CONFIG_ID has been specified to lock to a specific configuration.
  2. Values:
    1. Default: 10000 (milliseconds)
    2. 0: only check and auto-refresh if a configuration element is not found.
  3. Where used

SENZING_API_SERVER_BASE_PATH

  1. Synopsis:
    1. Sets the URL base path for the Senzing API Server.
  2. Values:
    1. Default: /
    2. Typically specified as a path beginning with / such as /api
  3. Where used

SENZING_API_SERVER_BIND_ADDR

  1. Synopsis:
    1. Sets the bind address for Senzing API Server HTTP communication. The specified value can be an IP Address, the keyword loopback for the local loopback address (e.g.: 127.0.0.1 for IPv4) or all to bind to all addresses (i.e.: network interfaces). If not provided the bind address defaults to the loopback address.
  2. Values:
    1. Default: loopback (for the local loopback address)
    2. An IP-Address for a specific network interface on the host
    3. The keyword all to indicate all network interfaces on the host.
  3. Where used

SENZING_API_SERVER_CLIENT_KEY_STORE

  1. Synopsis:
    1. Sets the Senzing API Server PKCS12 client key store file that holds the public keys of those clients that are authorized to connect. If this option is specified then SSL client authentication is required to connect and SENZING_API_SERVER_PORT option is forbidden.
    2. See SENZING_API_SERVER_SECURE_PORT
    3. See SENZING_API_SERVER_KEY_STORE
    4. See SENZING_API_SERVER_KEY_STORE_PASSWORD
    5. See SENZING_API_SERVER_KEY_ALIAS
    6. See SENZING_API_SERVER_CLIENT_KEY_STORE_PASSWORD
  2. Values:
    1. Default: N/A
    2. Specify a file path to the PKCS12 key store file that contains the public client keys for those clients that authotrized to connect.
  3. Where used

SENZING_API_SERVER_CLIENT_KEY_STORE_PASSWORD

  1. Synopsis:
    1. Sets the Senzing API Server PKCS12 client key store password to decrypt the client key store file that holds the public keys of those clients that are authorized to connect.
    2. See SENZING_API_SERVER_SECURE_PORT
    3. See SENZING_API_SERVER_KEY_STORE
    4. See SENZING_API_SERVER_KEY_STORE_PASSWORD
    5. See SENZING_API_SERVER_KEY_ALIAS
    6. See SENZING_API_SERVER_CLIENT_KEY_STORE
  2. Values:
    1. Default: N/A
    2. Specify a password to decrypt the PKCS12 client key store file that holds the public keys of those clients that are authorized to connect.
  3. Where used

SENZING_API_SERVER_CONFIG_ID

  1. Synopsis:
    1. Used to pin the configuration for the Senzing API Server to a specific configuration ID. If specified, then the Senzing API Server will not attempt to load the default configuration from the database, nor will it update automatically by refreshing the configuration when the default configuration gets updated. If not specified, the the default configuration configured in the repository is used and the Senzing API Server will automatically refresh the configuration when a change is detected.
  2. Values:
    1. Default: N/A
    2. If specified, then a valud Senzing configuration ID for the entity repository must be specified.
  3. Where used

SENZING_API_SERVER_CONCURRENCY

  1. Synopsis:
    1. Sets the number of threads available for the Senzing API Server to execute Senzing API functions (i.e.: the number of engine threads). If not specified, then this defaults to 8.
  2. Values:
    1. Default: 8
    2. If specified, then a non-zero integer should be provided. Take care not to make this too large.
  3. Where used

SENZING_API_SERVER_DEBUG

  1. Synopsis:
    1. Specifies whether or not the Senzing API Server should produce debug log messages on standard output. If this environment variable is set with no value (e.g.: empty-string) or with a value of true then the Senzing API Server will produce debug messages on standard output. If specified as false or if the environment variable is not set then the Senzing API Server will not produce debug messages.
    2. See SENZING_API_SERVER_VERBOSE
    3. See SENZING_API_SERVER_QUIET
  2. Values:
    1. Default: false
    2. Specify true or set the environment variable with no value (empty-string) to suppress output.
  3. Where used

SENZING_API_SERVER_ENABLE_ADMIN

  1. Synopsis:
    1. Controls whether or not to enable Senzing API Server administrative functions. Administrative functions include those that would modify the active configuration (e.g.: adding data sources). If the environment variable is set with no value or with a valueof true then administrative functions will be enabled. If the environment variable is not set or set with a value of false then administrative functions will return a 403 Forbidden response. NOTE: In order to make any modifications via the Senzing API Server, you will need to ensure that you are not in read only mode.
    2. See SENZING_API_SERVER_READ_ONLY
  2. Values:
    1. Default: false
    2. Specify true to enable administrative functions.
  3. Where used

SENZING_API_SERVER_HTTP_CONCURRENCY

  1. Synopsis:
    1. Sets the maximum number of threads available for the Senzing API Server's embedded HTTP server. The single parameter to this option should be a positive integer. If not specified, then this defaults to 200. If the specified thread count is less than 10 then an error is reported.
  2. Values:
    1. Default: 200
    2. If specified, then an integer greater-than 10 should be provided. Take care not to make this too large.
  3. Where used

SENZING_API_SERVER_INI_FILE

  1. Synopsis:
    1. Specifies the file path to the INI file containing the INI configuration with which to initialize the Senzing API Server. This is one of five environment variables that can be used to initialize the Senzing API Server.
    2. See SENZING_API_SERVER_INIT_FILE
    3. See SENZING_API_SERVER_INIT_JSON
    4. See SENZING_API_SERVER_INIT_ENV_VAR
    5. See SENZING_ENGINE_CONFIGURATION_JSON
  2. Values:
    1. Default: N/A
  3. Where used

SENZING_API_SERVER_INIT_ENV_VAR

  1. Synopsis:
    1. Specifies the the name of an alternate environment variable whose value is the JSON configuration with which to initialize the Senzing API Server. This is one of five environment variables that can be used to initialize the Senzing API Server.
    2. See SENZING_API_SERVER_INI_FILE
    3. See SENZING_API_SERVER_INIT_FILE
    4. See SENZING_API_SERVER_INIT_JSON
    5. See SENZING_ENGINE_CONFIGURATION_JSON
  2. Values:
    1. Default: N/A
    2. Should be the name of an environment variable that has been set and contians the JSON configuration.
  3. Where used

SENZING_API_SERVER_INIT_FILE

  1. Synopsis:
    1. Specifies the file path to the JSON file containing the JSON configuration with which to initialize the Senzing API Server. This is one of five environment variables that can be used to initialize the Senzing API Server.
    2. See SENZING_API_SERVER_INI_FILE
    3. See SENZING_API_SERVER_INIT_JSON
    4. See SENZING_API_SERVER_INIT_ENV_VAR
    5. See SENZING_ENGINE_CONFIGURATION_JSON
  2. Values:
    1. Default: N/A
  3. Where used

SENZING_API_SERVER_INIT_JSON

  1. Synopsis:
    1. Specifies the JSON configuration text with which to initialize the Senzing API Server. If not found, the Senzing API Server falls back to using the SENZING_ENGINE_CONFIGURATION_JSON environment variable. If both are specified then SENZING_API_SERVER_INIT_JSON takes priority for initializing the Senzing API Server.
    2. See SENZING_API_SERVER_INI_FILE
    3. See SENZING_API_SERVER_INIT_FILE
    4. See SENZING_API_SERVER_INIT_ENV_VAR
    5. See SENZING_ENGINE_CONFIGURATION_JSON
  2. Values:
    1. Default: N/A
  3. Where used

SENZING_API_SERVER_KEY_ALIAS

  1. Synopsis:
    1. Sets the Senzing API Server PKCS12 key store alias to identify the key to use from the key store file for the sever to identify itself for secure HTTPS communication
    2. See SENZING_API_SERVER_SECURE_PORT
    3. See SENZING_API_SERVER_KEY_STORE
    4. See SENZING_API_SERVER_KEY_STORE_PASSWORD
    5. See SENZING_API_SERVER_CLIENT_KEY_STORE
    6. See SENZING_API_SERVER_CLIENT_KEY_STORE_PASSWORD
  2. Values:
    1. Default: N/A
    2. Specify the key alias to choose the key from the PKCS12 key store file that the server is using.
  3. Where used

SENZING_API_SERVER_KEY_STORE

  1. Synopsis:
    1. Sets the Senzing API Server PKCS12 key store file that holds the private key that the sever uses to identify itself for secure HTTPS communication
    2. See SENZING_API_SERVER_SECURE_PORT
    3. See SENZING_API_SERVER_KEY_STORE_PASSWORD
    4. See SENZING_API_SERVER_KEY_ALIAS
    5. See SENZING_API_SERVER_CLIENT_KEY_STORE
    6. See SENZING_API_SERVER_CLIENT_KEY_STORE_PASSWORD
  2. Values:
    1. Default: N/A
    2. Specify a file path to the PKCS12 key store file for the server to use.
  3. Where used

SENZING_API_SERVER_KEY_STORE_PASSWORD

  1. Synopsis:
    1. Sets the Senzing API Server PKCS12 key store password to decrypt the key store file that holds the private key that the sever uses to identify itself for secure HTTPS communication
    2. See SENZING_API_SERVER_SECURE_PORT
    3. See SENZING_API_SERVER_KEY_STORE
    4. See SENZING_API_SERVER_KEY_ALIAS
    5. See SENZING_API_SERVER_CLIENT_KEY_STORE
    6. See SENZING_API_SERVER_CLIENT_KEY_STORE_PASSWORD
  2. Values:
    1. Default: N/A
    2. Specify a password to decrypt the PKCS12 key store file that the server is using.
  3. Where used

SENZING_API_SERVER_MODULE_NAME

  1. Synopsis:
    1. Sets the Senzing API Server module name with which to initialize the engine. If not specified, then the module name defaults to senzing-api-server
  2. Values:
    1. Default: senzing-api-server
  3. Where used

SENZING_API_SERVER_MONITOR_FILE

  1. Synopsis:
    1. Specifies a file whose timestamp is monitored to determine when the Senzing API Server should shut down. If not provided, then the monitor file will not be used to control Senzing API Server shutdown.
  2. Values:
    1. Default: N/A
    2. Value should be a file path that is visible to the Senzing API Server process.
  3. Where used

SENZING_API_SERVER_PORT

  1. Synopsis:
    1. Port for Senzing API Server HTTP communication. If not specified, then the default port (8250) is used. Specify 0 for a arbitrarily selected port number from the available ports. This option cannot be specified if SSL client authentication is configured for the Senzing API Server.
    2. See Port 8250
    3. See SENZING_API_SERVER_CLIENT_KEY_STORE
  2. Values:
    1. Default: 8250
    2. A valid non-zero integer for an available port may be specified.
    3. Specify 0 to have the Senzing API Server select an arbitrary port number from the available ports.
  3. Where used

SENZING_API_SERVER_QUIET

  1. Synopsis:
    1. Specifies whether or not the Senzing API Server should reduce the number of messages provided as feedback to standard output. This applies only to messages generated by the API Server and not by the underlying API which may still be initialized in verbose mode. If this environment variable is set with no value (e.g.: empty-string) or with a value of true then the Senzing API Server will suppress much of the feedback that is normally sent to standard output. If specified as false or if the environment variable is not set then the Senzing API Server will provide the normal feedback to standard output as it runs.
    2. See SENZING_API_SERVER_VERBOSE
    3. See SENZING_API_SERVER_DEBUG
  2. Values:
    1. Default: false
    2. Specify true or set the environment variable with no value (empty-string) to suppress output.
  3. Where used

SENZING_API_SERVER_READ_ONLY

  1. Synopsis:
    1. Controls whether or not to disable Senzing API Server functions that would modify the entity repository data. If the environment variable is set with no value or with a value of true then those functions that would modify the repository return a 403 Forbidden response. If the environment variable is unset or set with a value of false then functions that would modify the repository operate normally as documented. NOTE: this option will not only disable loading data to the entity repository, but will also disable modifications to the configuration even if admin functions are enabled.
    2. See SENZING_API_SERVER_ENABLE_ADMIN
  2. Values:
    1. Default: false
    2. Set to true to put the Senzing API Server in read-only mode.
  3. Where used

SENZING_API_SERVER_SECURE_PORT

  1. Synopsis:
    1. Sets the Senzing API Server port for secure HTTPS communication. While the default HTTPS port is 8263 if not specified, HTTPS is only enabled if the SENZING_API_SERVER_KEY_STORE environment variable is set. Specify zero (0) for an arbitrarily selected available port.
    2. See Port 8263
    3. See SENZING_API_SERVER_KEY_STORE
    4. See SENZING_API_SERVER_KEY_STORE_PASSWORD
    5. See SENZING_API_SERVER_KEY_ALIAS
    6. See SENZING_API_SERVER_CLIENT_KEY_STORE
    7. See SENZING_API_SERVER_CLIENT_KEY_STORE_PASSWORD
  2. Values:
    1. Default: 8263
    2. A valid non-zero integer for an available port may be specified.
    3. Specify 0 to have the Senzing API Server select an arbitrary port number from the available ports.
  3. Where used

SENZING_API_SERVER_SKIP_ENGINE_PRIMING

  1. Synopsis:
    1. Specifies whether or not the Senzing API Server will skip priming the Senzing engine at startup. If the environment variable is set with no value (e.g.: empty-string) or with the value of true then the engine priming that is performed by the Senzing API Server at startup will be skipped. If specified as false or if the environment variable is not set then the engine priming will be performed as normal on startup.
  2. Values:
    1. Default: false
    2. Specify true or set the environment variable with no value (empty-string) to skip the priming the engine.
  3. Where used

SENZING_API_SERVER_SKIP_STARTUP_PERF

  1. Synopsis:
    1. Specifies whether or not the Senzing API Server will skip the performance check at startup. If the environment variable is set with no value (e.g.: empty-string) or with a value of true then the performance check normally performed by the Senzing API Server will instead be skipped at startup. If specified as false or if the environment variable is not set then the performance check will be performed as normal on startup.
    2. See SENZING_API_SERVER_VERBOSE
  2. Values:
    1. Default: false
    2. Specify true or set the environment variable with no value (empty-string) to skip the performance check.
  3. Where used

SENZING_API_SERVER_STATS_INTERVAL

  1. Synopsis:
    1. Specifies the number of milliseconds between the Senzing API Server logging statistics. This is a minimum number of milliseconds because stats logging is suppressed while the Senzing API Server is idle or active but not performing activities pertaining to entity scoring. In such cases, stats logging is delayed until an activity pertaining to entity scoring is performed. By default this is set to the millisecond equivalent of 15 minutes. If zero (0) is specified then the logging of stats will be suppressed.
  2. Values:
    1. Default: 900000 (milliseconds -- the equivalent of 15 minutes)
    2. 0: suppress logging of statistics
    3. Any positive integer will be interpretted as a number of milliseconds. Negative numbers are not allowed.
  3. Where used

SENZING_API_SERVER_URL

  1. Synopsis:
    1. A URL consisting of host:port running Senzing API Server.
    2. See Port 8250
  2. Values:
    1. Format: http://${hostname}:${SENZING_API_SERVICE_PORT}
    2. Default: None
  3. Examples:

    1. Using hostname.

      export SENZING_API_SERVER_URL="http://example.com:8250"

SENZING_API_SERVER_VERBOSE

  1. Synopsis:

    1. Specifies whether or not the Senzing API Server should initialize the Senzing engine in verbose mode. If the environment variable is set with no value (e.g.: empty-string) or with a value of true then the Senzing API Server will initialize the Senzing engine in verbose mode. If specified as false or if the environment variable is not set then the Senzing API Server will initialize the Senzing engine with verbosity disabled.
    2. See SENZING_API_SERVER_QUIET
    3. See SENZING_API_SERVER_DEBUG

  2. Values:

    1. Default: false
    2. Specify true or set the environment variable with no value (empty-string) to intialize in verbose mode.

  3. Where used

  4. Where used

SENZING_AZURE_CONNECTION_STRING

  1. Where used

SENZING_AZURE_FAILURE_CONNECTION_STRING

  1. Where used

SENZING_AZURE_FAILURE_QUEUE_NAME

  1. Where used

SENZING_AZURE_INFO_CONNECTION_STRING

  1. Where used

SENZING_AZURE_INFO_QUEUE_NAME

  1. Where used

SENZING_AZURE_QUEUE_NAME

  1. Where used

SENZING_CONFIGURATION_CHECK_FREQUENCY

  1. Synopsis:
    1. Determine how often to check for a change in the Senzing configuration.
  2. Where used

SENZING_CONFIGURATION_MODIFICATIONS

  1. Synopsis:
    1. A list of data sources to add to a Senzing configuration.
  2. Where used

SENZING_CONFIG_PATH

  1. Synopsis:
    1. Used for PIPELINE.CONFIGPATH value in G2 Engine configuration.
  2. Values:
    1. Default: /etc/opt/senzing
  3. Where used

SENZING_DATA_DIR

  1. Where used

SENZING_DATA_SOURCE

  1. Synopsis:
    1. Default "DATA_SOURCE" value for incoming records. If a JSON line does not have the DATA_SOURCE key/value, this value is inserted.
  2. Values:
    1. Default: none
  3. Forms:
    1. Helm: senzing.dataSource
  4. Where used

SENZING_DATA_VERSION_DIR

  1. Synopsis:
    1. Path on the local system where Senzing data/nn.nnn.nnn directory is located. It differs from the value of the SENZING_DATA_DIR environment variable used in installing Senzing because it includes the version of the data in the path. This directory contains immutable data files used by Senzing G2.
  2. Values:
    1. Default: none
    2. Usually set to /opt/senzing/data/1.0.0
  3. Where used

SENZING_DATABASE_URL

  1. Synopsis:

    1. Database URI in the form:

      DATABASE_PROTOCOL://DATABASE_USERNAME:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_DATABASE.

  2. Values:

    • Default: Use the internal SQLite database.

  3. Examples:

    1. MySQL

      export SENZING_DATABASE_URL=mysql://username:password@host.example.com:3306/G2

    2. PostgreSQL

      export SENZING_DATABASE_URL=postgresql://username:password@host.example.com:5432/G2

    3. Db2:

      export SENZING_DATABASE_URL=db2://username:password@host.example.com:50000/G2

    4. SQLite

      export SENZING_DATABASE_URL=sqlite3://na:na@/var/opt/senzing/sqlite/G2C.db

  4. Forms:

    1. Helm: senzing.databaseUrl

  5. Where used

SENZING_DEBUG

  1. Synopsis:

    1. Enable debug information.

  2. Values:

    • 0 = no debug
    • 1 = debug
    • Default: 0

  3. Examples:

    1. Turn debugging on

      export SENZING_DEBUG=1

  4. Forms:

    1. Helm: senzing.debug

  5. Where used

SENZING_DELAY_IN_SECONDS

  1. Synopsis:
    1. Time to delay before actually starting process
    2. Used for simple choreography.
  2. Where used

SENZING_DELAY_RANDOMIZED

  1. Where used

SENZING_DOCKER_HOST_IP_ADDR

  1. Synopsis:

    1. The IP address of the system hosting Docker containers.

  2. Examples:

    1. Manually specify. Example:

      export SENZING_DOCKER_HOST_IP_ADDR=10.1.1.100

    2. To find the value for SENZING_DOCKER_HOST_IP_ADDR use Python interactively: Example:

      python3

      Copy and paste the following lines into the Python REPL (Read-Evaluate-Print Loop):

      import socket

sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
sock.connect(("8.8.8.8", 80))
print("export SENZING_DOCKER_HOST_IP_ADDR={0}".format(sock.getsockname()[0]))
sock.close()
quit()

      Copy and paste the printed export statement into the host terminal.

  3. Where used

SENZING_DOCKER_IMAGE_VERSION_ADMINER

  1. Synopsis:
    1. The desired version of senzing/adminer.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_APT

  1. Synopsis:
    1. The desired version of senzing/apt.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_DB2_DRIVER_INSTALLER

  1. Synopsis:
    1. The desired version of senzing/db2-driver-installer.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_ENTITY_SEARCH_WEB_APP

  1. Synopsis:
    1. The desired version of senzing/entity-search-web-app.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_ENTITY_SEARCH_WEB_APP_CONSOLE

  1. Synopsis:
    1. The desired version of senzing/entity-search-web-app-console.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_INIT_CONTAINER

  1. Synopsis:
    1. The desired version of senzing/init-container.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_JUPYTER

  1. Synopsis:
    1. The desired version of senzing/jupyter.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_PHPPGADMIN

  1. Synopsis:
    1. The desired version of senzing/phppgadmin.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_PORTAINER

  1. Synopsis:
    1. The desired version of portainer/portainer.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_POSTGRES

  1. Synopsis:
    1. The desired version of postgres.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_POSTGRESQL_CLIENT

  1. Synopsis:
    1. The desired version of senzing/postgresql-client.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_RABBITMQ

  1. Synopsis:
    1. The desired version of bitnami/rabbitmq.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_REDOER

  1. Synopsis:
    1. The desired version of senzing/redoer.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_RESOLVER

  1. Synopsis:
    1. The desired version of senzing/resolver.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_SENZING_API_SERVER

  1. Synopsis:
    1. The desired version of senzing/senzing-api-server.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_SENZING_CONSOLE

  1. Synopsis:
    1. The desired version of senzing/console.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_SENZING_DEBUG

  1. Synopsis:
    1. The desired version of senzing/senzing-debug.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_SQLITE_WEB

  1. Synopsis:
    1. The desired version of coleifer/sqlite-web.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_SSHD

  1. Synopsis:
    1. The desired version of senzing/sshd.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_STREAM_LOADER

  1. Synopsis:
    1. The desired version of senzing/stream-loader.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_STREAM_LOGGER

  1. Synopsis:
    1. The desired version of senzing/stream-logger.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_STREAM_PRODUCER

  1. Synopsis:
    1. The desired version of senzing/stream-producer.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_WEB_APP_DEMO

  1. Synopsis:
    1. The desired version of senzing/web-app-demo.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_XTERM

  1. Synopsis:
    1. The desired version of senzing/xterm.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_IMAGE_VERSION_YUM

  1. Synopsis:
    1. The desired version of senzing/yum.
  2. To see latest version, visit docker-versions-latest.sh
  3. Where used

SENZING_DOCKER_LAUNCHED

  1. Where used

SENZING_DOCKER_SOCKET

  1. Synopsis:

    1. Location of socket used to communicate with Docker.

  2. Examples:

    1. Common Linux location

      export SENZING_DOCKER_SOCKET=/var/run/docker.sock

  3. Where used

SENZING_DOCKERHUB_API_ENDPOINT_V1

  1. Synopsis:

    1. URL of the docker registry's Version 1 API.

  2. Examples:

    1. registry.hub.docker.com

      export SENZING_DOCKERHUB_API_ENDPOINT_V1=https://registry.hub.docker.com/v1

  3. Where used

SENZING_DOCKERHUB_API_ENDPOINT_V2

  1. Synopsis:

    1. URL of the docker registry's Version 2 API.

  2. Examples:

    1. hub.docker.com

      export SENZING_DOCKERHUB_API_ENDPOINT_V2=https://hub.docker.com/v2

  3. Where used

SENZING_DOCKERHUB_ORGANIZATION

  1. Synopsis:

    1. Organization name on hub.docker.com

  2. Examples:

    1. A "senzing" organization.

      export SENZING_DOCKERHUB_ORGANIZATION=senzing

  3. Where used

SENZING_DOCKERHUB_PASSWORD

  1. Synopsis:
    1. SENZING_DOCKERHUB_USERNAME's password for logging into hub.docker.com
  2. Where used

SENZING_DOCKERHUB_USERNAME

  1. Synopsis:
    1. Login username for for hub.docker.com
  2. Where used

SENZING_DOWNLOAD_DIR

  1. Synopsis:

    1. Directory on local system where a download will be placed.

  2. Examples:

    1. Download to /tmp/my-downloads

      export SENZING_DOWNLOAD_DIR=/tmp/my-downloads

  3. Where used

SENZING_DOWNLOAD_FILE

  1. Synopsis:

    1. Location of where to place a downloaded file.

  2. Examples:

    1. Download to /tmp/my-downloads/x-file.tmp

      export SENZING_DOWNLOAD_FILE=/tmp/my-downloads/x-file.tmp

  3. Where used

SENZING_ENGINE_CONFIGURATION_JSON

  1. Synopsis:

    1. A JSON string that is a parameter to the Senzing Engine's *.init() function.

  2. Examples:

    1. Using system installation paths and PostgreSQL database URL:

      export SENZING_ENGINE_CONFIGURATION_JSON='{
    "PIPELINE": {
        "CONFIGPATH": "/etc/opt/senzing",
        "RESOURCEPATH": "/opt/senzing/g2/resources",
        "SUPPORTPATH": "/opt/senzing/data"
    },
    "SQL": {
        "CONNECTION": "postgresql://username:password@example.com:5432:g2"
    }
}'

  3. Where used

SENZING_ENTITY_TYPE

  1. Synopsis:
    1. Default "ENTITY_TYPE" value for incoming records. If a JSON line does not have the ENTITY_TYPE key/value, this value is inserted.
  2. Values:
    1. Default: none
  3. Forms:
    1. Helm: senzing.entityType
  4. Where used

SENZING_ETC_DIR

  1. Synopsis:
    1. Path on the local system where Senzing etc directory is located. This directory contains Senzing configuration templates and files.
  2. Values:
    1. Default: none
    2. Usually set to /etc/opt/senzing
  3. Where used

SENZING_EXIT_ON_EMPTY_QUEUE

  1. Synopsis:
    1. Signify that program should end when queue is empty.
  2. Values:
    1. Datatype: boolean
    2. Default: False
  3. Where used

SENZING_EXIT_ON_THREAD_TERMINATION

  1. Synopsis:
    1. Exit program when no more threads are running.
    2. Used when external queues (RabbitMQ, SQS, Kafka) are specified.
    3. Facilitates scale-down when using container orchestration systems (e.g. Kubernetes, Openshift, etc.)
  2. Values:
    1. Datatype: boolean
    2. Default: False
  3. Where used

SENZING_EXIT_SLEEP_TIME_IN_SECONDS

  1. Synopsis:
    1. Amount of time to sleep before exiting.
    2. Used in autoscaling to slow down "cool down".
  2. Values:
    1. Default: 0
  3. Where used

SENZING_EXPIRATION_WARNING_IN_DAYS

  1. Synopsis:
    1. Number of days before logging Senzing license expiration notices.
  2. Values:
    1. Default: 30
  3. Where used

SENZING_G2_DIR

  1. Synopsis:
    1. Path on the local system where Senzing g2 directory is located. This directory contains Senzing G2 code.
  2. Values:
    1. Default: none
    2. Usually set to /opt/senzing/g2
  3. Where used

SENZING_GID

  1. Where used

SENZING_GOVERNOR_DATABASE_URLS

  1. Synopsis:

    1. A list of one or more comma-separated SENZING_DATABASE_URLs.

  2. Examples:

    1. Single SENZING_DATABASE_URL. Example:

      export SENZING_GOVERNOR_DATABASE_URLS=postgresql://username:password@host.example.com:5432/G2

    2. Multiple SENZING_DATABASE_URLs. Example:

      export SENZING_GOVERNOR_DATABASE_URLS=postgresql://username:password@host.example.com:5432/G2,postgresql://username:password@host.example.com:5432/G2_RES

  3. Where used

SENZING_GOVERNOR_INTERVAL

  1. Synopsis:

    1. The number of records "skipped" before executing the analysis for governing.

  2. Examples:

    1. Analyze once every 10 million records. Example:

      export SENZING_GOVERNOR_INTERVAL=10000000

  3. Where used

SENZING_GOVERNOR_LIST_SEPARATOR

  1. Synopsis:

    1. The character used to separate items in a list.

  2. Values:

    1. Default: "," (a single comma)

  3. Examples:

    1. Use a plus sign instead of a comma. Example:

      export SENZING_GOVERNOR_LIST_SEPARATOR="+"

  4. Where used

SENZING_GOVERNOR_POSTGRESQL_HIGH_WATERMARK

  1. Synopsis:

    1. The maximum age of the PostgreSQL transaction ID (XID) before "governance" starts.

  2. Values:

    1. Default: 10000000000 (10 billion)

  3. Examples:

    1. Set to 9 billion. Example:

      export SENZING_GOVERNOR_POSTGRESQL_HIGH_WATERMARK=9000000000

  4. Where used

SENZING_GOVERNOR_POSTGRESQL_LOW_WATERMARK

  1. Synopsis:

    1. The maximum age of the PostgreSQL transaction ID (XID) before "governance" stops.

  2. Values:

    1. Default: 9000000000 (9 billion)

  3. Examples:

    1. Set to 7 billion. Example:

      export SENZING_GOVERNOR_POSTGRESQL_LOW_WATERMARK=7000000000

  4. Where used

SENZING_GOVERNOR_PROJECT_DIR

  1. Synopsis:

    1. A directory where governor and test code are placed.

  2. Examples:

    1. Set to 7 billion. Example:

      export SENZING_GOVERNOR_PROJECT_DIR=~/test-governor

  3. Where used

SENZING_GOVERNOR_WAIT

  1. Synopsis:

    1. The number of seconds to wait before querying the database.

  2. Values:

    1. Default: 15 seconds

  3. Examples:

    1. Set to 10 minutes. Example:

      export SENZING_GOVERNOR_WAIT=600

  4. Where used

SENZING_HOST

  1. Where used

SENZING_INIT_CONTAINER_SLEEP

  1. Synopsis:
    1. Time to sleep, in seconds, before doing initialization
  2. Values:
    1. Default: 0
  3. Where used

SENZING_INPUT_FILE

  1. Where used

SENZING_INPUT_SQL_URL

  1. Where used

SENZING_INPUT_URL

  1. Synopsis:
    1. URL of source file.
  2. Values:
    1. Default: none
  3. Where used

SENZING_INTERNAL_DATABASE

  1. Where used

SENZING_KAFKA_BOOTSTRAP_SERVER

  1. Synopsis:
    1. Hostname and port of Kafka server.
  2. Values:
    1. Default: localhost:9092
  3. Where used

SENZING_KAFKA_CONFIGURATION

  1. Where used

SENZING_KAFKA_FAILURE_BOOTSTRAP_SERVER

  1. Where used

SENZING_KAFKA_FAILURE_CONFIGURATION

  1. Where used

SENZING_KAFKA_FAILURE_TOPIC

  1. Where used

SENZING_KAFKA_GROUP

  1. Synopsis:
    1. Kafka group.
  2. Values:
    1. Default: "senzing-kafka-group"
  3. Where used

SENZING_KAFKA_INFO_BOOTSTRAP_SERVER

  1. Where used

SENZING_KAFKA_INFO_CONFIGURATION

  1. Where used

SENZING_KAFKA_INFO_GROUP

  1. Synopsis:
    1. Kafka group for the info messages.
  2. Values:
    1. Default: The value from SENZING_KAFKA_GROUP
  3. Where used

SENZING_KAFKA_INFO_TOPIC

  1. Where used

SENZING_KAFKA_TOPIC

  1. Synopsis:
    1. Kafka topic.
  2. Values:
    1. Default: "senzing-kafka-topic"
  3. Where used

SENZING_LOG_LEVEL

  1. Synopsis:
    1. Level of logging
  2. Values:
    1. notset
    2. debug
    3. info
    4. warning
    5. error
    6. critical
    7. Default: info
  3. Forms:
    1. Helm: senzing.logLevel
  4. Where used

SENZING_LOG_LICENSE_PERIOD_IN_SECONDS

  1. Synopsis:
    1. Interval between logging Senzing license information.
  2. Values:
    1. Default: 1 day
  3. Where used

SENZING_MONITORING_PERIOD

  1. Synopsis:
    1. Time, in seconds, between monitoring log records.
  2. Values:
    1. Default: 300
  3. Where used

SENZING_MONITORING_PERIOD_IN_SECONDS

  1. Synopsis:
    1. Time, in seconds, between monitoring log records.
  2. Values:
    1. Default: 600
  3. Where used

SENZING_NETWORK

  1. Synopsis:

    1. Used in docker-compose formations to identify the docker network.

  2. Examples:

    1. Search for network in docker-compose:

      sudo docker network ls

# Choose value from NAME column of docker network ls
export SENZING_NETWORK=nameofthe_network

  3. Where used

SENZING_OPT_IBM_DIR

  1. Synopsis:
    1. Path on the local system where the /opt/IBM code resides. For instance, the Db2 client driver configuration would be located at ${SENZING_OPT_IBM_DIR}/db2/clidriver/cfg/db2dsdriver.cfg
  2. Values:
    1. Default: none
    2. Usually set to /opt/IBM
  3. Where used

SENZING_OPT_MICROSOFT_DIR

  1. Synopsis:
    1. Path on the local system where the /opt/microsoft code resides.
  2. Values:
    1. Default: none
    2. Usually set to /opt/microsoft
  3. Where used

SENZING_OUTPUT_FILE

  1. Where used

SENZING_PLUGINS_DIR

  1. Synopsis:

    1. Path on the local system where plugin files are located.

  2. Values:

    1. Default: none

  3. Examples:

    1. Using an IP address:

      export SENZING_PLUGINS_DIR=${GIT_REPOSITORY_DIR}/resources/plugins

  4. Where used

SENZING_PORT

  1. Where used

SENZING_PORTAINER_DIR

  1. Synopsis:
    1. A directory where Portainer can keep variable data.
  2. Where used

SENZING_PRIME_ENGINE

  1. Where used

SENZING_PSTACK_PID

  1. Where used

SENZING_PROJECT_DIR

  1. Synopsis:

    1. A path to a Senzing project.

  2. Examples:

    1. A project in the home directory. Example:

      export SENZING_PROJECT_DIR=~/my-senzing-project

  3. Where used

SENZING_PROJECT_NAME

  1. Synopsis:

    1. The name of a Senzing project.
    2. Used as a prefix when creating objects for the project.

  2. Examples:

    1. A project in the home directory. Example:

      export SENZING_PROJECT_NAME=~/test01

  3. Where used

SENZING_SQL_CONNECTION

  1. Synopsis:

    1. A database URI in the form native to the database client driver.
    2. This differs from SENZING_DATABASE_URL, which has been "normalized" and is not in the native format.

  2. Examples:

    1. Using an IP address:

      export SENZING_SQL_CONNECTION=mysql://username:password@host.example.com:3306/?schema=schemaname

  3. Where used

SENZING_QUEUE_MAX

  1. Synopsis:
    1. Maximum items for internal queue.
  2. Values:
    1. Default: 10
  3. Where used

SENZING_RABBITMQ_EXCHANGE

  1. Synopsis:
    1. Name of the RabbitMQ exchange used for routing messages.
  2. Values
    1. Default: "senzing-rabbitmq-exchange"
  3. Where used

SENZING_RABBITMQ_FAILURE_EXCHANGE

  1. Synopsis:
    1. Name of the RabbitMQ exchange used for routing info messages about loaded records
  2. Where used

SENZING_RABBITMQ_FAILURE_HOST

  1. Synopsis:
    1. Host name of the RabbitMQ server used to post records that failed to load
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_HOST
  3. Where used

SENZING_RABBITMQ_FAILURE_PASSWORD

  1. Synopsis:
    1. The password for the RabbitMQ failure server.
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_PASSWORD
  3. Where used

SENZING_RABBITMQ_FAILURE_PORT

  1. Synopsis:
    1. The port to use to connect to the RabbitMQ server specified by SENZING_RABBITMQ_FAILURE_HOST
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_PORT
  3. Where used

SENZING_RABBITMQ_FAILURE_QUEUE

  1. Synopsis:
    1. Name of the RabbitMQ queue used for records that failed to load.
  2. Values:
    1. Default: "senzing-rabbitmq-queue"
  3. Where used

SENZING_RABBITMQ_FAILURE_ROUTING_KEY

  1. Synopsis:
    1. The RabbitMQ routing key to use when creating a binding or publishing a record.
  2. Values:
    1. Default: "senzing.failure"
  3. Where used

SENZING_RABBITMQ_FAILURE_USERNAME

  1. Synopsis:
    1. The username for the RabbitMQ server.
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_USERNAME
  3. Where used

SENZING_RABBITMQ_FAILURE_VIRTUAL_HOST

  1. Synopsis:
    1. The name of the virtual host where the failure queue exists.
  2. Values:
    1. Default: SENZING_RABBITMQ_VIRTUAL_HOST
  3. Where used

SENZING_RABBITMQ_HEARTBEAT_IN_SECONDS

  1. Synopsis:
    1. Heartbeat time in seconds on connections to the RabbitMQ server.
  2. Values:
    1. Default: "60"
  3. Where used
    1. stream-loader

SENZING_RABBITMQ_HOST

  1. Synopsis:
    1. Host name of the RabbitMQ server.
  2. Values:
    1. Default: "localhost:5672"
  3. Where used

SENZING_RABBITMQ_INFO_EXCHANGE

  1. Synopsis:
    1. Name of the RabbitMQ exchange used for routing info messages about loaded records
  2. Where used

SENZING_RABBITMQ_INFO_HOST

  1. Synopsis:
    1. Host name of the RabbitMQ server used to post the info about a loaded record
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_HOST
  3. Where used

SENZING_RABBITMQ_INFO_PASSWORD

  1. Synopsis:
    1. The password for the RabbitMQ info server.
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_PASSWORD
  3. Where used

SENZING_RABBITMQ_INFO_PORT

  1. Synopsis:
    1. The port to use to connect to the RabbitMQ server specified by SENZING_RABBITMQ_INFO_HOST
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_PORT
  3. Where used

SENZING_RABBITMQ_INFO_QUEUE

  1. Synopsis:
    1. Name of the RabbitMQ queue used for communication.
  2. Values:
    1. Default: "senzing-rabbitmq-queue"
  3. Where used

SENZING_RABBITMQ_INFO_ROUTING_KEY

  1. Synopsis:
    1. The RabbitMQ routing key to use when creating a binding or publishing a record.
  2. Values:
    1. Default: "senzing.info"
  3. Where used

SENZING_RABBITMQ_INFO_USERNAME

  1. Synopsis:
    1. The username for the RabbitMQ server.
  2. Values:
    1. Default: The value of SENZING_RABBITMQ_USERNAME
  3. Where used

SENZING_RABBITMQ_INFO_VIRTUAL_HOST

  1. Synopsis:
    1. The name of the virtual host where the info queue exists.
  2. Values:
    1. Default: SENZING_RABBITMQ_VIRTUAL_HOST
  3. Where used

SENZING_RABBITMQ_PASSWORD

  1. Synopsis:
    1. The password for the RabbitMQ queue.
  2. Values:
    1. Default: "bitnami"
  3. Where used

SENZING_RABBITMQ_PORT

  1. Synopsis:
    1. The port to use to connect to the RabbitMQ server specified by SENZING_RABBITMQ_HOST
  2. Values:
    1. Default: "5672"
  3. Where used

SENZING_RABBITMQ_PREFETCH_COUNT

  1. Synopsis:
    1. The number of records to get from the RabbitMQ queue in one request. Reduces the number of overall requests to the RabbitMQ server and improves performance.
  2. Values:
    1. Default: 50
  3. Where used

SENZING_RABBITMQ_PUBLISH_BATCH_SIZE

  1. Synopsis:
    1. The number of records to publish to RabbitMQ in a batch
  2. Values:
    1. Default: "1000"
  3. Where used

SENZING_RABBITMQ_PUBLISH_INTERVAL

  1. Synopsis:
    1. How often (in seconds) to publish a batch of records to the RabbitMQ Queue
  2. Values:
    1. Default: "0.0"
  3. Where used

SENZING_RABBITMQ_QUEUE

  1. Synopsis:
    1. Name of the RabbitMQ queue used for communication.
  2. Values:
    1. Default: "senzing-rabbitmq-queue"
  3. Where used

SENZING_RABBITMQ_RECONNECT_DELAY_IN_SECONDS

  1. Synopsis:
    1. The time (in seconds) to wait between attempts to reconnect to the RabbitMQ broker.
  2. Values:
    1. Default: 60
  3. Where used

SENZING_RABBITMQ_RECONNECT_NUMBER_OF_RETRIES

  1. Synopsis:
    1. The number of times to try reconnecting a dropped connection to the RabbitMQ broker.
  2. Values:
    1. Default: 10
  3. Where used

SENZING_RABBITMQ_ROUTING_FAILURE_KEY

  1. Synopsis:
    1. The RabbitMQ routing key to use when creating a binding to the failure queue or publishing to the failure exchange.
  2. Values:
    1. Default: "senzing.failure"
  3. Where used

SENZING_RABBITMQ_ROUTING_INFO_KEY

  1. Synopsis:
    1. The RabbitMQ routing key to use when creating a binding to the info queue or publishing to the info exchange.
  2. Values:
    1. Default: "senzing.info"
  3. Where used

SENZING_RABBITMQ_ROUTING_KEY

  1. Synopsis:
    1. The RabbitMQ routing key to use when creating a binding or publishing a record.
  2. Values:
    1. Default: "senzing.records"
  3. Where used

SENZING_RABBITMQ_USERNAME

  1. Synopsis:
    1. The username for the RabbitMQ queue.
  2. Values:
    1. Default: "user"
  3. Where used

SENZING_RABBITMQ_USE_EXISTING_ENTITIES

  1. Synopsis:
    1. Use existing RabbitMQ entities (exchanges, queues). That is, don't create the entities.
  2. Where used

SENZING_RABBITMQ_VIRTUAL_HOST

  1. Synopsis:
    1. The name of the virtual host where the queues exists.
  2. Values:
    1. Default: The RabbitMQ defined default virtual host, which is currently ''
  3. Where used

SENZING_RANDOM_SEED

  1. Synopsis:
    1. Identify seed for random number generator. Value of 0 uses system clock. Values greater than 0 give repeatable results.
  2. Values:
    1. Default: "0"
  3. Where used

SENZING_RECORD_IDENTIFIER

  1. Synopsis:
    1. JSON key whose value uniquely identifies a record.
    2. Used to identify specific records when logging errors.
  2. Values:
    1. Default: "RECORD_ID"
  3. Where used

SENZING_RECORD_MAX

  1. Synopsis:
    1. Identify highest record number to generate.
  2. Values:
    1. Value of 0 means no maximum.
    2. Default: "0"
  3. Where used

SENZING_RECORD_MIN

  1. Synopsis:
    1. Identify lowest record number to generate.
  2. Values:
    1. Default: "1"
  3. Where used

SENZING_RECORD_MONITOR

  1. Synopsis:
    1. Write a log record every N mock records.
  2. Values:
    1. Default: "10000"
  3. Where used

SENZING_RECORDS_PER_SECOND

  1. Synopsis:
    1. Throttle output to a specified records per second.
  2. Values:
    1. Value of 0 means no throttling.
    2. Default: "0"
  3. Where used

SENZING_RECORD_SIZE_MAX

  1. Synopsis:
    1. Maximum size of a record that will be sent to a Queue.
    2. Records that exceed the maximum size will be logged.
      1. See SENZING_RECORD_IDENTIFIER
  2. Values:
    1. Value of 0 means no maximum.
    2. Default: "0"
  3. Where used

SENZING_RESOURCE_PATH

  1. Synopsis:
    1. Used in PIPELINE_RESOURCEPATH for G2 Engine configuration.
  2. Values:
    1. Default: /opt/senzing/g2/resources
  3. Where used

SENZING_RPM_FILENAME

  1. Synopsis:
    1. Filename for the Senzing API RPM file.
  2. Values:
    1. Format: senzingapi-MM.mm.PP.x86_64.rpm
    2. Default: none
  3. Where used

SENZING_RUNAS_USER

  1. Synopsis:

    1. A parameter for the docker run statement to force the container to run as a specific user.

  2. Values:

    1. Default: 1001

  3. Examples:

    1. root

      export SENZING_RUNAS_USER="0"

  4. Where used

SENZING_SKIP_DATABASE_PERFORMANCE_TEST

  1. Synopsis:
    1. When true, do not perform initial performance evaluation.
  2. Where used

SENZING_SKIP_GOVERNOR

  1. Where used

SENZING_SKIP_INFO_FILTER

  1. Where used

SENZING_SLEEP_TIME

  1. Synopsis:
    1. Amount of time to sleep, in seconds, before running command.
  2. Forms:
    1. Helm: senzing.sleepTime
  3. Where used

SENZING_SLEEP_TIME_IN_SECONDS

  1. Where used

SENZING_SQS_DEAD_LETTER_QUEUE_ENABLED

  1. Synopsis:
    1. Indicate that an AWS SQS "dead-letter" queue has been enables.
    2. This changes the logging behavior.
  2. Where used

SENZING_SQS_FAILURE_QUEUE_URL

  1. Synopsis:
    1. The Amazon SQS Queue URL used convey messages that cannot be processed by the Senzing Engine.
  2. Examples:
    1. https://sqs.us-east-1.amazonaws.com/000000000000/senzing-failure-queue
  3. Where used

SENZING_SQS_INFO_QUEUE_DELAY_SECONDS

  1. Synopsis:
    1. The length of time, in seconds, for which to delay a specific message on the Info queue.
  2. Values:
    1. Default: 10
  3. References:
    1. Boto3 send_message See DelaySeconds parameter.
  4. Where used

SENZING_SQS_INFO_QUEUE_URL

  1. Synopsis:
    1. The Amazon SQS Queue URL used convey "withInfo" messages from the Senzing Engine.
  2. Examples:
    1. https://sqs.us-east-1.amazonaws.com/000000000000/senzing-info-queue
  3. Where used

SENZING_SQS_QUEUE_URL

  1. Synopsis:
    1. The Amazon SQS Queue URL used convey messages for ingestion into the Senzing Engine.
  2. Examples:
    1. https://sqs.us-east-1.amazonaws.com/000000000000/senzing-queue
  3. Where used

SENZING_SQS_WAIT_TIME_SECONDS

  1. Synopsis:
    1. For use with SQS "long-polling"
  2. Where used

SENZING_STREAM_LOADER_DIRECTIVE_NAME

  1. Synopsis:
    1. The property name in a JSON Message that identifies a JSON property with information to be used by the stream-loader.
    2. More information at stream-loader.
  2. Values:
    1. Default: senzingStreamLoader
  3. Where used

SENZING_SUBCOMMAND

  1. Synopsis:
    1. Identify the subcommand to be run.
  2. Values:
    1. Run program-name --help for complete list.
  3. Forms:
    1. Helm: senzing.subcommand
  4. Where used

SENZING_SUPPORT_PATH

  1. Where used

SENZING_THREADS_PER_PROCESS

  1. Synopsis:
    1. Number of threads per process to allocate for processing.
  2. Values:
    1. Default: 4
  3. Where used

SENZING_TOOLS_CONFIG_PATH

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_CONFIGURATION

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_DATABASE_URL

  1. Synopsis:
    1. A string in URL format specifying a database connection point.
  2. Values:
    1. Format: DATABASE_PROTOCOL://DATABASE_USERNAME:DATABASE_PASSWORD@DATABASE_HOST:DATABASE_PORT/DATABASE_DATABASE/?DATABASE_QUERY_PARAMETERS.
  3. Examples:
    1. MsSQL: "mssql://username:password@host.example.com:1433/G2"
    2. MySQL: "mysql://username:password@host.example.com:3306/G2"
    3. PostgreSQL: "postgresql://username:password@host.example.com:5432/G2/?sslmode=disable"
    4. PostgreSQL: "postgresql://username:password@host.example.com:5432/G2"
    5. Sqlite3: "sqlite3://na:na@/tmp/sqlite/G2C.db"
  4. Where used

SENZING_TOOLS_DATASOURCES

  1. Synopsis:

    1. A string listing one or more space-delimited datasource identifiers.

  2. Values:

    1. Format: "datasource1 datasource2 datasource3"

  3. Examples:

    1. Using export:

      export SENZING_TOOLS_DATASOURCES="CUSTOMER REFERENCE WATCHLIST"

  4. Where used

SENZING_TOOLS_DELAY_IN_SECONDS

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_ALL

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_G2CONFIG

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_G2CONFIGMGR

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_G2DIAGNOSTIC

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_G2ENGINE

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_G2PRODUCT

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_SENZING_CHAT_API

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_SENZING_REST_API

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_SWAGGER_UI

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENABLE_XTERM

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENGINE_CONFIGURATION_FILE

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_ENGINE_CONFIGURATION_JSON

  1. Synopsis:

    1. A string of JSON containing configuration information sent to the Senzing engine.
    2. SENZING_TOOLS_ENGINE_CONFIGURATION_JSON is used as the iniParams value of G2engine.Init().

  2. Examples:

    1. Sample JSON:

      {
    "PIPELINE": {
        "CONFIGPATH": "/etc/opt/senzing",
        "RESOURCEPATH": "/opt/senzing/g2/resources",
        "SUPPORTPATH": "/opt/senzing/data"
    },
    "SQL": {
        "CONNECTION": "postgresql://username:password@host.example.com:G2/?sslmode=disable"
    }
}

    2. Setting a SENZING_TOOLS_ENGINE_CONFIGURATION_JSON environment variable:

      export SENZING_TOOLS_ENGINE_CONFIGURATION_JSON='{
    "PIPELINE": {
        "CONFIGPATH": "/etc/opt/senzing",
        "RESOURCEPATH": "/opt/senzing/g2/resources",
        "SUPPORTPATH": "/opt/senzing/data"
    },
    "SQL": {
        "CONNECTION": "postgresql://username:password@host.example.com:G2/?sslmode=disable"
    }
}'

  3. References:

    1. G2Engine Configuration and the Senzing API
    2. Scaling Out Your Database With Clustering

  4. Where used

SENZING_TOOLS_ENGINE_LOG_LEVEL

  1. Synopsis:
    1. An integer specifying how much logging is done by the Senzing engine.
    2. SENZING_TOOLS_ENGINE_LOG_LEVEL is used as the verboseLogging value of G2engine.Init().
  2. Values:
    1. 0 - no logging
    2. 1 - logging
  3. Where used

SENZING_TOOLS_ENGINE_MODULE_NAME

  1. Synopsis:
    1. An string given to the Senzing engine to identify the instance of the Senzing engine.
    2. SENZING_TOOLS_ENGINE_MODULE_NAME is used as the moduleName value of G2engine.Init().
  2. Values:
    1. Default: none
  3. Where used

SENZING_TOOLS_GRPC_PORT

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_GRPC_URL

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_HTTP_PORT

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_INPUT_FILE_TYPE

  1. Synopsis: File type to treat the specificed input file (given by SENZING_TOOLS_INPUT_URL) as.
  2. Example: JSONL
  3. Where used

SENZING_TOOLS_INPUT_URL

  1. Synopsis: Input URL used for processing.
  2. Values: valid URL
  3. Examples:
    1. file:///path/to/json/lines/file.jsonl
    2. https://public-read-access.s3.amazonaws.com/TestDataSets/SenzingTruthSet/truth-set-3.0.0.jsonl
  4. Where used

SENZING_TOOLS_JSON_OUTPUT

  1. Synopsis: Output log messages as JSON.
  2. Values:
    1. true
    2. false
  3. Where used

SENZING_TOOLS_LICENSE_STRING_BASE64

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_LOG_LEVEL

  1. Synopsis:
    1. An string specifying the amount of logging desired.
  2. Values:
    1. "TRACE" - Entry/Exit tracing. Will show sensitive data.
    2. "DEBUG" - Values see during processing. May show sensitive data.
    3. "INFO" - Process steps achieved.
    4. "WARN" - Unexpected situations, but processing was successful.
    5. "ERROR" - Unexpected situations, processing was not successful.
    6. "FATAL" - The process needs to shutdown.
    7. "PANIC" - The underlying system is at issue.
  3. References:
    1. Log Levels
  4. Where used

SENZING_TOOLS_MONITORING_PERIOD_IN_SECONDS

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_NUMBER_OF_WORKERS

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_OBSERVER_ORIGIN

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_OBSERVER_URL

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_OUTPUT_URL

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_RECORD_MAX

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_RECORD_MIN

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_RECORD_MONITOR

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_RESOURCE_PATH

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_SENZING_DIRECTORY

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_SERVER_ADDRESS

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_SQL_FILE

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_SUPPORT_PATH

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_VISIBILITY_PERIOD_IN_SECONDS

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_XTERM_ALLOWED_HOSTNAMES

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_XTERM_ARGUMENTS

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_XTERM_COMMAND

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_XTERM_CONNECTION_ERROR_LIMIT

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_XTERM_KEEPALIVE_PING_TIMEOUT

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_TOOLS_XTERM_MAX_BUFFER_SIZE_BYTES

  1. Synopsis:
  2. Values:
  3. Examples:
  4. Where used

SENZING_UID

  1. Where used

SENZING_VAR_DIR

  1. Synopsis:
    1. Path on the local system where Senzing var directory is located. This directory contains files that may mutate during execution.
  2. Values:
    1. Default: none
    2. Usually set to /var/opt/senzing
  3. Where used

SENZING_VOLUME

  1. Where used

SENZING_WEB_SERVER_PORT

  1. Synopsis:
    1. Port on localhost for Senzing Entity Search WebApp.
    2. See Port 8251
  2. Values:
    1. Default: 8251
  3. Where used

SENZING_WEBAPP_PORT

  1. Synopsis:
    1. Port on localhost for Docker web application service.
  2. Values:
    1. Default: none
  3. Where used

SQLITE_DATABASE

  1. Synopsis:
    1. Name of SQLite database containing Senzing schema.
  2. Values:
    1. Usual value: G2C.db
    2. Default: none
  3. Where used

References

  1. GitHub environment variables