GitHubContribute in GitHub: Edit online

copyright: years: 2017, 2018 lastupdated: "2023-02-12"


Connecting through a forward proxy server

For additional security, your organization might deploy SMS Gateway in a environment that requires HTTP requests to pass through a forward proxy server. In this environment, you must configure SMS Gateway to connect through the proxy server to the SMS provider and the Watson Assistant service.

You can configure the same proxy server for both the SMS provider and the Watson Assistant service, or connect through different proxy servers. If your proxy server requires authentication, you can also specify the user name and password for HTTP Basic authentication.

Connecting to the SMS provider through a proxy server

In the SMS Gateway configuration, specify the forward proxy server details as shown in the following example:

# Proxy configuration
- SMS_PROXY_TYPE=HTTP
- SMS_PROXY_HOST=app.proxy.com
- SMS_PROXY_PORT=8080

# Basic authentication credentials
- SMS_PROXY_USERNAME=johndoe
- SMS_PROXY_PASSWORD=password1
Table 1. Environment variables for connecting to the SMS provider through a proxy server
Environment variable Default value Description
SMS_PROXY_TYPE HTTP The forward proxy server type for connections to the SMS provider. Set to HTTP for an unsecured server and HTTPS for a secured server.
SMS_PROXY_HOST N/A The host name of a forward proxy server for connections to the SMS provider.
SMS_PROXY_PORT N/A The port of the forward proxy server for connections to the SMS provider.
SMS_PROXY_USERNAME N/A The user name for the forward proxy server for connections to the SMS provider. Specify this variable only if the proxy server requires authentication.
SMS_PROXY_PASSWORD N/A The password for the forward proxy server for connections to the SMS provider. Specify this variable only if the proxy server requires authentication.

Connecting to the Watson Assistant service through a proxy server

In the SMS Gateway configuration, specify the forward proxy server details as shown in the following example:

# Proxy configuration
- WCS_PROXY_TYPE=HTTP
- WCS_PROXY_HOST=app.proxy.com
- WCS_PROXY_PORT=8080

# Basic authentication credentials
- WCS_PROXY_USERNAME=johndoe
- WCS_PROXY_PASSWORD=password1
Table 2. Environment variables for connecting to the Watson Assistant service through a proxy server
Environment variable Default value Description
WCS_PROXY_TYPE HTTP The forward proxy server type for the connections to the Watson Assistant service. Set to HTTP for an unsecured server and HTTPS for a secured server.
WCS_PROXY_HOST N/A The host name of a forward proxy server for connections to the Watson Assistant service.
WCS_PROXY_PORT N/A The port of the forward proxy server for connections to the Watson Assistant service.
WCS_PROXY_USERNAME N/A The user name for the forward proxy server for connections to the Watson Assistant service. Specify this variable only if the proxy server requires authentication.
WCS_PROXY_PASSWORD N/A The password for the forward proxy server for connections to the Watson Assistant service. Specify this variable only if the proxy server requires authentication.