Skip to content
Thomas Howe edited this page Aug 15, 2016 · 4 revisions

The following environment variables control the configuration of GreenBot. They can be controlled directly through the environment, or a .env file in the root directory.

Greenbot Core

  • MONGO_URL : Required Mongo URL. Defaults to 'mongodb://localhost:27017/greenbot'
  • DEFAULT_LANG: Default human language for watson translation. Defaults to 'en'
  • DEV_ROOM_NAME : Override normal collection of room names for dev
  • GREENBOT_BOT_SERVER_PORT: Specifies express web server port. Used for network call backs, APIs. Defaults to 3001
  • GREENBOT_NPM_PATH: Relative path to NPM installed modules. Defaults to './node_modules/'
  • REDIS_PORT: Redis server port. Defaults to 6379
  • REDIS_HOST: Redis server hostname. Defaults to 'localhost'
  • TRACE_MESSAGES: Shows much tracing on the command line. export TRACE_MESSAGES=YES to enable, unset TRACE_MESSAGES to disable
  • DEV_ROOM_NAME: Default network handle for local telnet testing. Defaults to 'development::telnet'
  • GB_SOCKET_PORT: Port for socket.io adapter. Defaults to 3003

Grasshopper Network Adapter

TSG Global Network Adapter

  • TSG_CALLBACK_HOST: Host name for TSG inbound webhooks
  • TSG_SECRET: Token for sending TSG messages
  • TSG_COBRA_KEY: Token for changing postback URL for inbound webhooks

ZipWhip Adapter

  • ZW_NUMBER: Zipwhip number
  • ZW_PASS: Zipwhip password

IBM Watson Dialogs

  • WATSON_DIALOG_PASS: Password for watson bot dialogs
  • WATSON_DIALOG_USERNAME: Username for watson bot dialogs
  • WATSON_DIALOG_ID: Id for watson bot dialogs

IBM Watson Language Translation

  • WATSON_USERNAME, WATSON_PASSWORD : BlueMix credentials for human language translation

Greenbot Core Test Tools

  • CONSOLE_SRC: default source for tools/test.coffee. Defaults to console.
  • GB_SOCKET_URL: URL for GB socket, used by tools/test.coffee. Defaults to 'http://127.0.0.1:3003'
  • TSG_COBRA_KEY: Token for changing postback URL for inbound webhook. Used by tools/tsg_webhook_config.coffee

Greenbot Admin

Prior to installing greenbot-admin, install meteor curl https://install.meteor.com/ | sh

  • GREENBOT_IO_URL: Required The default address of socket.io interface to GreenBot. Used to support running bots
  • ROOT_URL : Required Root URL for the admin portal from the admin portal. default: 'http://localhost:3003'
  • GREENBOT_BOT_SERVER_PORT: The port that the GB API is listening to on localhost. default: 3001