ENV

February 27, 2025 ยท View on GitHub

This article is designed to provide additional context in regards to potentially ENV values consumed within this project. These values can be provided by any means, but, it is recommended to specify a ./.env file for maximum compatibility with this project.

Environment VariableDetailsDefault
ATLAS_SERVICE_URLUsed to populate the atlasServiceUrl pre-discovery confighttps://atlas-a.wbx2.com/admin/api/v1
CLIENT_LOGS_SERVICE_URLUsed to populate the clientLogsServiceUrl pre-discovery confighttps://client-logs-a.wbx2.com/api/v1
CONVERSATION_SERVICEUsed for validating an auth tokenhttps://conv-a.wbx2.com/conversation/api/v1
ENABLE_MERCURY_LOGGINGWhen set, will log all mercury messagesundefined
ENABLE_VERBOSE_NETWORK_LOGGINGUtilized to enable interceptor loggingundefined
ENCRYPTION_SERVICE_URLUsed for plugin-board testshttps://encryption-a.wbx2.com
HYDRA_SERVICE_URLStores the public hydra API URL for managing Webex resources.https://api.ciscospark.com/v1/
IDBROKER_BASE_URLUsed throughout the SDK as the endpoint for authorizationhttps://idbroker.webex.com
IDENTITY_BASE_URLUsed to communicate with the identity APIhttps://identity.webex.com
MERCURY_FORCE_CLOSE_DELAYMilliseconds to wait for a before declaring the socket dead2000
MERCURY_PING_INTERVALMilliseconds between pings sent up the socket15000
MERCURY_PONG_TIMEOUTMilliseconds to wait for a pong before declaring the connection dead14000
METRICS_SERVICE_URLUsed to populate the metricsServiceUrl pre-discovery confighttps://metrics-a.wbx2.com/metrics/api/v1
U2C_SERVICE_URLStores the service catalog collecting url, typically the U2C service.https://u2c.wbx2.com/u2c/api/v1
SQDISCOVERY_SERVICE_URLStores the url for client region information lookupshttps://ds.ciscospark.com/v1/region
WEBEX_ACCESS_TOKENUsed to provide access token when using "webex/env"undefined
WEBEX_AUTHORIZE_URLPopulates the Authorization URL which prompts for the user's password.https://idbroker.webex.com/idb/oauth2/v1/authorize
WEBEX_AUTHORIZATION_STRINGThis is the authorization URL for the integration from Cisco Webex for Developersundefined
WEBEX_CLIENT_IDThe Webex client ID used to authorizeundefined
WEBEX_CLIENT_SECRETThe Webex client secret used to authorizeundefined
WEBEX_CONVERSATION_CLUSTER_SERVICEService identifier used to lookup conversation servers in hostmapidentityLookup
WEBEX_CONVERSATION_DEFAULT_CLUSTERCluster used to convert from "us" cluster to actual clusterurn:TEAM:us-east-2_a:identityLookup
WEBEX_LOG_LEVELMaximum log level that should be printed to the console.log
WEBEX_REDIRECT_URIThe URI to redirect to after authorizationundefined
WEBEX_SCOPEThe Webex scope the users will authorize withundefined
WDM_SERVICE_URLThe WDM service URL before the catalog is downloadedhttps://wdm-a.wbx2.com/wdm/api/v1
WHISTLER_API_SERVICE_URLThe URL to the whistler test servicehttps://whistler-prod.allnint.ciscospark.com/api/v1
WHISTLERRun (meetings) tests using Whistler usersFALSE
JENKINSRun specific tests that should be run on (internal) JenkinsFALSE