Web proxy configuration

To configure the client-side .NET SDK to connect to LaunchDarkly through a web proxy:

var handler = new System.Net.Http.HttpClientHandler();
handler.Proxy = new System.Net.WebProxy("http://my-proxy-host:8080");
var config = Configuration
    .Builder("example-mobile-key", ConfigurationBuilder.AutoEnvAttributes.Enabled)
    .Http(Components.HttpConfiguration().MessageHandler(handler))
    .Build();

To configure the client-side .NET SDK to connect to LaunchDarkly through a web proxy with authentication:

var handler = new System.Net.Http.HttpClientHandler();
var proxy = new System.Net.WebProxy("http://my-proxy-host:8080");
var credentials = new System.Net.CredentialCache();
credentials.Add(proxy.Address, "Basic",
    new NetworkCredential("username", "password"));
proxy.Credentials = credentials;
handler.Proxy = proxy;
var config = Configuration
    .Builder("example-mobile-key", ConfigurationBuilder.AutoEnvAttributes.Enabled)
    .Http(Components.HttpConfiguration().MessageHandler(handler))
    .Build();

The SDK supports HTTP, HTTPS, and SOCKS proxies. If you do not configure a proxy explicitly, the SDK uses curl’s proxy environment variables (ALL_PROXY, HTTP_PROXY, HTTPS_PROXY). To disable proxy usage, including the environment variables, set the proxy to an empty string.

To configure the client-side C++ SDK to connect to LaunchDarkly through a web proxy:

// Requires an SDK build with -DLD_CURL_NETWORKING=ON.
auto config_builder = client_side::ConfigBuilder("example-mobile-key");
config_builder.HttpProperties().Proxy("https://web-proxy.domain.com:8080");

To configure the client-side C++ SDK to connect to LaunchDarkly through a web proxy with authentication:

// Requires an SDK build with -DLD_CURL_NETWORKING=ON.
auto config_builder = client_side::ConfigBuilder("example-mobile-key");
config_builder.HttpProperties().Proxy(
    "https://username:password@web-proxy.domain.com:8080");

To configure the server-side .NET SDK to connect to LaunchDarkly through a web proxy:

var proxy = new System.Net.WebProxy("http://my-proxy-host:8080");
var config = Configuration.Builder("YOUR_SDK_KEY")
    .Http(Components.HttpConfiguration().Proxy(proxy))
    .Build();

To configure the server-side .NET SDK to connect to LaunchDarkly through a web proxy with authentication:

var proxyUri = new Uri("http://my-proxy-host:8080");
var proxy = new System.Net.WebProxy(proxyUri);
var credentials = new System.Net.CredentialCache();
credentials.Add(proxy.Address, "Basic",
    new NetworkCredential("username", "password"));
proxy.Credentials = credentials;
var config = Configuration.Builder("YOUR_SDK_KEY")
    .Http(Components.HttpConfiguration().Proxy(proxy))
    .Build();

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.

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:

export HTTPS_PROXY=https://my-proxy-host:8080

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:

export HTTPS_PROXY=https://my-proxy-host:8080

You can also specify a proxy programmatically through the SDK configuration:

import (
    ld "github.com/launchdarkly/go-server-sdk/v6"
    "github.com/launchdarkly/go-server-sdk/v6/ldcomponents"
)
var config ld.Config
config.HTTP = ldcomponents.HTTPConfiguration().
    ProxyURL("https://my-proxy-host:8080")

To configure the Java SDK to connect to LaunchDarkly through a web proxy:

LDConfig config = new LDConfig.Builder()
  .http(Components.httpConfiguration().proxyHostAndPort("my-proxy-host", 8080))
  .build();

To configure the Java SDK to connect to LaunchDarkly through a web proxy with authentication:

LDConfig config = new LDConfig.Builder()
  .http(Components.httpConfiguration()
    .proxyHostAndPort("my-proxy-host", 8080)
    .proxyAuth(Components.httpBasicAuthentication("username", "password")))
  .build();

To configure the server-side Node.js SDK to connect to LaunchDarkly through a web proxy:

import { LDOptions } from '@launchdarkly/node-server-sdk';
const options: LDOptions = {
  proxyOptions: {
      host: 'your-proxy-host',
      port: 8080,
      scheme: 'https'
    }
};

To configure the server-side Node.js SDK to connect to LaunchDarkly through a web proxy with authentication:

import { LDOptions } from '@launchdarkly/node-server-sdk';
const options: LDOptions = {
  proxyOptions: {
      host: 'your-proxy-host',
      port: 8080,
      scheme: 'https',
      auth: 'username:password'
    }
};

To learn more, read proxyOptions.

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:

export HTTPS_PROXY=https://my-proxy-host:8080

Or it can be set from within Python:

import os
os.environ["HTTPS_PROXY"] = "https://my-proxy-host:8080"

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:

export HTTPS_PROXY=https://my-proxy-host:8080

Or it can be set from within Ruby:

ENV['HTTPS_PROXY'] = 'https://my-proxy-host:8080'

Starting in version 3.0, the Rust SDK’s transport layer automatically detects proxy settings from environment variables. The SDK supports HTTP_PROXY, HTTPS_PROXY, and NO_PROXY. Lowercase variants take precedence over uppercase.

The proxy routing behavior is:

• Both HTTP_PROXY and HTTPS_PROXY set: HTTP requests use HTTP_PROXY, HTTPS requests use HTTPS_PROXY.
• Only HTTP_PROXY set: All requests, including HTTPS, route through HTTP_PROXY.
• Only HTTPS_PROXY set: Only HTTPS requests use the proxy. HTTP requests connect directly.
• Neither set: All requests connect directly with no proxy.

Use NO_PROXY to bypass the proxy for specific hosts. It accepts a comma-separated list of host names or * to disable the proxy for all hosts.

Here is an example:

export HTTPS_PROXY=https://my-proxy-host:8080

To configure the Rust SDK to connect to LaunchDarkly through a web proxy with authentication, include the credentials in the proxy URL:

export HTTPS_PROXY="https://username:password@my-proxy-host:8080"

You can also configure a proxy programmatically, or disable proxy support entirely:

use launchdarkly_sdk_transport::HyperTransport;
// Use a custom proxy URL
let transport = HyperTransport::builder()
    .proxy_url("https://my-proxy-host:8080".to_string())
    .build_http()?;
// Disable proxy completely
let transport = HyperTransport::builder()
    .disable_proxy()
    .build_http()?;