Web proxy configuration
Read time: 7 minutes
Last edited: Oct 07, 2024
Overview
This topic explains how to configure an SDK to connect to LaunchDarkly through a web proxy. This feature is available for client-side and server-side SDKs.
Connecting to LaunchDarkly through a web proxy is not related to using LaunchDarkly's Relay Proxy. To learn about LaunchDarkly's Relay Proxy, read The Relay Proxy.
Connecting though a web proxy
If your organization requires that you use a web proxy to connect to external resources, you must configure your LaunchDarkly SDKs to connect through the proxy instead of connecting to LaunchDarkly directly.
Some proxies require authentication with a username and password, or with custom headers. Instructions on how to configure the SDK to send these parameters are in the SDK-specific sections.
In the following examples, the web proxy's hostname is "my-proxy-host" and it uses port 8080. Substitute the appropriate values for your proxy. Details about each SDK's configuration are available in the SDK-specific sections below:
Android, Flutter, iOS, and React Native support using a web proxy through their device operating systems (OS). You can use their onboard OS settings to configure a web proxy.
Client-side SDKs
This feature is available in the following client-side SDKs:
.NET (client-side)
Expand .NET (client-side) code sample
To configure the client-side .NET SDK to connect to LaunchDarkly through a web proxy:
To configure the client-side .NET SDK to connect to LaunchDarkly through a web proxy with authentication:
C++ (client-side)
Expand C++ (client-side) code sample
This feature is available in the client-side C++ SDK's version 2.x only. It is not yet available in version 3.0.
To configure the client-side C/C++ SDK to connect to LaunchDarkly through a web proxy:
To configure the client-side C/C++ SDK to connect to LaunchDarkly through a web proxy with authentication:
Server-side SDKs
.NET (server-side)
Expand .NET (server-side) code sample
To configure the server-side .NET SDK to connect to LaunchDarkly through a web proxy:
To configure the server-side .NET SDK to connect to LaunchDarkly through a web proxy with authentication:
This example uses basic authentication. However, other options are supported: the proxy that you pass to the ConfigurationBuilder in the line .Http(Components.HttpConfiguration().Proxy(proxy)) can be any implementation of System.Net.IWebProxy. If you choose to use a different implementation of System.Net.IWebProxy, you may need to make corresponding configuration updates elsewhere in your system. For example, if you use Microsoft's NTLM authentication, you may also need to enable System.Net.Security.UseManagedNtlm in your .NET project.
To learn more, read Http and HttpConfigurationBuilder.
Apex
Expand Apex code sample
The Apex bridge that provides and retrieves flag values is written in Go, and uses the default Go networking mechanisms.Â
Go's standard HTTP library recognizes the environment variables HTTP_PROXY and HTTPS_PROXY. If you set these variables, the SDK will connect through a web proxy at the URL you provide. Because the LaunchDarkly services have https: URLs, you use HTTPS_PROXY. If you are connecting to services at an insecure http: URL use HTTP_PROXY instead.
Here is an example:
Go
Expand Go code sample
There are two ways to specify proxy server parameters in the Go SDK.
Go's standard HTTP library recognizes the environment variables HTTP_PROXY and HTTPS_PROXY. If you set these variables, the SDK will connect through a web proxy at the URL you provide. Because the LaunchDarkly services have https: URLs, you use HTTPS_PROXY. If you are connecting to services at an insecure http: URL, such as a Relay Proxy instance, use HTTP_PROXY instead.
Here is an example:
You can also specify a proxy programmatically through the SDK configuration:
Java
Expand Java code sample
To configure the Java SDK to connect to LaunchDarkly through a web proxy:
To configure the Java SDK to connect to LaunchDarkly through a web proxy with authentication:
Node.js (server-side)
Expand Node.js (server-side) code sample
To configure the server-side Node.js SDK to connect to LaunchDarkly through a web proxy:
To configure the server-side Node.js SDK to connect to LaunchDarkly through a web proxy with authentication:
To learn more, read proxyOptions.
Python
Expand Python code sample
There are two ways to specify proxy server parameters in the Python SDK.
Python's standard HTTP library recognizes the environment variables HTTP_PROXY and HTTPS_PROXY. If you set these variables, the SDK will connect through a web proxy at the URL you provide. Because the LaunchDarkly services have https: URLs, you use HTTPS_PROXY. If you are connecting to services at an insecure http: URL, such as a Relay Proxy instance, use HTTP_PROXY instead.
How to set the HTTPS_PROXY environment variable on Mac/Linux and Windows systems:
Or it can be set from within Python:
Ruby
Expand Ruby code sample
There are two ways to specify proxy server parameters in the Ruby SDK.
Ruby's standard HTTP library recognizes the environment variables HTTP_PROXY and HTTPS_PROXY. If you set these variables, the SDK will connect through a web proxy at the URL you provide. Because the LaunchDarkly services have https: URLs, you use HTTPS_PROXY. If you are connecting to services at an insecure http: URL, such as a Relay Proxy instance, use HTTP_PROXY instead.
To configure the Ruby SDK to connect to LaunchDarkly through a web proxy:
Or it can be set from within Ruby: