Environment Variables¶
The Genvid SDK uses many environment variables for its configuration. Some of the key variables are defined below.
-
BINDIR
¶ A variable pointing to the binaries directory (named
bin
) underROOTDIR
. It is likely to be deprecated in the near future.
-
CONSUL_HTTP_ADDR
¶ The Consul client address, not including the protocol. Our applications and SDK will respect it if present.
-
CURDIR
¶ A variable used by the script to communicate the current directory location. It is likely to be deprecated in the near future.
-
GENVID_BASTION_URL
¶ A variable used by the script to communicate with the bastion-api. The system will use Consul discovery by default.
-
DOCKER_MACHINE_NAME
¶ The docker host machine name. When set, it allows the
genvid.toolbox.DockerTool
to connect to the Docker host using docker-machine.
-
GENVID_AUDIO_DEVICE
¶ The name of the audio device to use. If it is not set the default audio endpoint will be used.
-
GENVID_DEFAULT_IP
¶ Overrides the default IP of 127.0.0.q1 for binding the services locally. The usage of this variable is explained in the Setting the local IP section.
-
GENVID_LOGGER_PREFIX
¶ The prefix used by the SDK logger.
-
GENVID_SERVICES_DATADIR
¶ This variable indicates the location of the data directory for the Bastion supervision services.
-
GENVID_SESSION_NAME
¶ The name of the RTMSP session used by the Genvid SDK. This name must be unique in the project. A unique name is created if this variable is absent.
-
GENVID_STARTUP_TIMEOUT
¶ The timeout used by genvid-bastion for launching the supervisor services.
-
GENVID_STATIC_BINDING
¶ This variable is used inside the local Nomad templates (under
bastion-services/templates
) to allocate a fixed port for each service. The service uses a port allocated dynamically by nomad if not set.
-
GENVID_STATSD_URL
¶ The url for the StatsD server to use. The default address (udp://127.0.0.1:8125) is used if not set. Currently the only scheme available is
udp
.
-
GENVID_TOOLBOX_LOGLEVEL
¶ The default logging level of the scripts.
-
GENVID_TOOLBOX_VERSION
¶ The version of the installed toolbox.
-
GENVID_VAULT_POLICIES_FOLDER
¶ The folder where Vault can find its policies. See
genvid.toolbox.VaultTool.vault_load_policies()
.
-
GENVID_VAULT_TOKEN_ROLES_FOLDER
¶ The folder where Vault can find its roles. See
genvid.toolbox.VaultTool.vault_load_token_roles()
.
-
GVENCODE_FONT_DIR
¶ The directory where gvencode can find its fonts.
-
HOME
¶ A variable to the user home directory. Usually points to
USERPROFILE
on Windows.
-
PROJECTDIR
¶ This variable is set by the sample scripts to the value of their current directory. Used mostly to set the location of binaries in the local environment.
-
PYTHON_EXECUTABLE
¶ A variable pointing to the current Python executable in the Toolbox.
-
ROOTDIR
¶ This variable points to the SDK install directory. Use by the Toolbox. It is likely to be deprecated in the near future.
-
STUDIO_WEB_DIR
¶ The folder location of the studio web site studiod.
-
UE4ENGINEDIR
¶ The Engine repository of the an Unreal Engine 4 installation. By default, it should be
UE4ROOT/Engine
, whereUE4ROOT
is the installation directory of the engine. See Cube Sample Application for more information.
-
UTROOT
¶ The clone repository of UnrealTournament. See Unreal Tournament Integration for more information.
-
VAULT_ADDR
¶ The address to the Vault service.
-
VAULT_KEYS
¶ The keys used to unseal Vault.
-
VAULT_TOKEN
¶ The token used to connect to Vault.
-
GENVID_DISCO_SECURE
¶ Enables wss scheme for leaf service when this environment variable contains true.
-
GENVID_LEAF_KEY_FILE
¶ Contains the path of the private key file to use WebSocket secure.
-
GENVID_LEAF_CERT_FILE
¶ Contains the path of the TLS certificate file to use WebSocket secure.