Salesforce

aiWARE environment variables

« Go Back
Information
aiWARE environment variables
000004186
Public
Product Selection
aiWare - aiWare
Article Details

Environment variables control the behavior of your aiWARE installation. Setting up a node to install aiWARE services consists of assigning (exporting) the run mode that corresponds to the service that you want to install to an aiWARE environment variable. After exporting the variables, download and install aiWARE with the curl command.

To export variables and use the curl command, you need to have the appropriate permissions of the sudo su command.

aiWARE installation variables

VariableDefaultDescription
AIWARE_ROOT/opt/aiwareThe aiWARE install directory
AIWARE_MODEnilThis is the mode for the host. This can be a comma separated list of modes. See the list and description of the available run modes.
INSTALL_AIWARE_SKIP_STARTFalseIf true, the installer will not start aiWARE
INSTALL_AIWARE_SKIP_SERVICEFalseIf true, the installer will not install aiWARE as a service
AIWARE_GIT_VERSIONnilIf set, this specifies the git commit to use for the version
AIWARE_MANIFEST_TIERstableInstall a version from this release tier. The tiers are: dev, unstable, stable
AIWARE_MANIFEST_VERSIONnilVersion to install. By default it will use the most recent version
INSTALL_AIWARE_BIN_DIR/usr/local/binThis specifies the location of the binary directory for aiWARE binaries
INSTALL_AIWARE_SYSTEMD_DIR/etc/systemd/systemThis specifies the systemd directory
INSTALL_AIWARE_NAMEagentThis will create the binary as aiware-agent
INSTALL_AIWARE_EXECnilThese are the arguments for aiware-agent
INSTALL_RELEASES_URL_PREFIXdistThis is the prefix used for binaries

aiWARE configuration environment variables

VariableDefaultDescription
AIWARE_CONTROLLERhttp://_LOCAL_IP_:9000/edge/v1URI to controller. Either config or AIWARE_CONTROLLER is required. This will default to http://IP:9000/edge/v1
AIWARE_LOG_LEVELinfoThe API Token to use with controller
AIWARE_LICENSEnilThe license key for aiWARE
AIWARE_CORE_TOKENnilToken
AIWARE_CLUSTERIDnilCluster Id
AIWARE_CORE_URLhttps://api.veritone.com/v3/graphqlURL for Veritone API
AIWARE_HOST_IPnilAgent will use this IP instead of trying to figure out which IP to use if the host has multiple
AIWARE_SLACK_URLnilSlack URL to use
AIWARE_SLACK_CHANNELnilIf enabled, will use the default slack channel
AIWARE_ENVIRONMENTlocalThe name of the environment
AIWARE_DB_MIGRATEMigrate the DB UP first thing
AIWARE_MODENoneThis is the mode for the host. This can be a comma separated list. See the list and description of the available run modes.
AIWARE_SERVER_TYPENilThis defaults to the host type from the cloud provider.
AIWARE_NFS_ROOT/dataThis is the default directory for serving NFS /cache
AIWARE_RUN_CONFIG/var/run/aiware-agent.json
AIWARE_CACHE/cacheThis is the directory used for cache
AIWARE_HOST_EXPIREtrueIf yes or true, this host will expire. If any other value, then the host will not expire
AIWARE_AUTOREMOVE_ENGINEStrueThis sets AutoRemove on the docker containers after they exit
AIWARE_REGISTRY_ROOT/opt/aiware/registryThe registry root
AIWARE_REGISTRY_PORT9001The port to use when launching the docker registry
AIWARE_REGISTRY_IMAGEregistry:latest
AIWARE_CONTROLLER_PORT9000The port to use when launching controller
AIWARE_CONTROLLER_IMAGEaiware-controller:latestThe image to use when launching controller
AIWARE_CONTROLLER_AUTH_DISABLEDNULLDisable authentication
AIWARE_CONTROLLER_PRIMARY_DISABLEfalseDisables primary for controller
AIWARE_PROMETHEUS_IMAGEprom/prometheus:v2.14.0The prometheus image to launch
AIWARE_PROMETHEUS_PORT9090The port to use for prometheus
AIWARE_PROMETHEUS_ROOT/opt/aiware/prometheusThe directory that will be used for /etc/prometheus
AIWARE_AWSLOGS_ENABLEDfalseEnable AWSLOGS/Cloudwatch for agents
AIWARE_AWSLOGS_REGIONus-east-1Region for the logs
AIWARE_AWSLOGS_GROUPaiwareLog group for the logs
AIWARE_AWSLOGS_STREAMv3fLog stream to use
AIWARE_ES_IMAGEdocker.elastic.co/elasticsearch/elasticsearchElasticSearch Docker image to launch
AIWARE_ES_VERSION7.7.1ElasticSearch version to launch
AIWARE_ES_PORT9200Port to use for ElasticSearch
AIWARE_ES_HOSTlocalhostHost to use for ElasticSearch
AIWARE_ES_DISCOVERYTYPEsingle-modeThe mode of ElasticSearch to run. Currently only single-mode is available. Works only with elasticsearch mode
AIWARE_ES_DATA/opt/aiware/elasticsearchThe root directory for ElasticSearch. Works only with elasticsearch mode
AIWARE_ES_MASTERtrueIf the node is a master node for ElasticSearch. Works only with elasticsearch mode
AIWARE_ES_MEMORYLOCKtrueMemory lock of heap space during garbage collection. Works only with elasticsearch mode
AIWARE_ES_CLUSTERNAMEaiware-elasticsearchThe name of the ElasticSearch cluster. Works only with elasticsearch mode
AIWARE_ES_HEAPSIZE1gHeap size of Elasticsearch. Works only with elasticsearch mode
AIWARE_LOG_SHIPPERbeatsType of log shipper to use
AIWARE_INIT_TOKENnoneIf set, the controller on startup will create this token
AIWARE_NO_UPDATE_IMAGESnilList of modes that should not update images from the internet before starting. If an image is not already present on the host, it will still be retrieved. Accepts the same values asĀ AIWARE_MODE except "None" and "Single." "All" will prevent any image from being updated.

Environment variables for engines launched

VariableDefaultDescriptionAvailble
AIWARE_CONTROLLERnilURI to controller. Either config or AIWARE_CONTROLLER is requiredEngine Toolkit Only
AIWARE_HOST_IDHostIdAll
AIWARE_IDLaunch Id RequestAll
AIWARE_LICENSELicense Key for Engine ToolkitEngine Toolkit Only
AIWARE_EXPIRATIONNOW()+900Expiration time for the Engine ToolkitAll
AIWARE_ENGINE_IDAll
AIWARE_ENGINE_SCRATCH/cache/engine//scratchAll
AIWARE_ENGINE_INSTANCE_SCRATCH/cache/engine//All
Additional Technical Documentation Information
Properties
2/15/2024 9:55 PM
12/9/2025 10:11 PM
12/9/2025 10:11 PM
Documentation
Documentation
000004186
Translation Information
English

Powered by