Using proxy mode - LaunchDarkly

Each SDK connects to several LaunchDarkly web services. These include services for getting feature flag data via streaming or polling, and a service for storing analytics events. By default, the SDK connects directly to LaunchDarkly for these services. If you are using the Relay Proxy, you must configure the SDK so that it connects to the Relay Proxy for these services instead. If you use the Relay Proxy in proxy mode, you must know the base uniform resource identifier (URI) of your Relay Proxy instance. This is an http or https address with the hostname and port where you have deployed the Relay Proxy. In all of the code examples below, the Relay Proxy’s base URI is https://your-relay-proxy.com:8030, which is its default port. Different SDKs have different ways of configuring the SDK. In some SDKs, you must set the base URI of each service to the Relay Proxy’s base URI, using a separate configuration property for each service but setting each one to the same value. In other SDKs, you can set the base URI for all services with a single configuration property. The examples below show how to configure the SDK for each service. In most SDKs, you then need to pass the configuration in as a parameter when you initialize the client. To learn more, read SDK configuration. The following examples also include configuring the events service. To learn more, read Deciding how to handle analytics events. Details about each SDK’s configuration are available in the SDK-specific sections below:

Client-side SDKs
Server-side SDKs

Client-side SDKs

This feature is available in the following client-side SDKs:

.NET (client-side)
Android
C++ (client-side)
Electron
Flutter
iOS
JavaScript
Node.js (client-side)
React Native
React Web The React Web SDK relies on the JavaScript SDK for these configuration options.
Roku
Vue: The Vue SDK relies on the JavaScript SDK for these configuration options.

.NET (client-side)

Expand .NET (client-side) code sample

To connect the SDK to the Relay Proxy, use the ServiceEndpoints builder method and Components.ServiceEndpoints().RelayProxy to specify the base URI of your Relay Proxy:

var config = Configuration
    .Builder("example-mobile-key", ConfigurationBuilder.AutoEnvAttributes.Enabled)
    .ServiceEndpoints(Components.ServiceEndpoints()
      .RelayProxy("https://your-relay-proxy.com:8030"))
    .Build();

Android

Expand Android code sample

To connect the SDK to the Relay Proxy, use the streamUri, pollUri, and eventsUri builder methods to specify the base URI of your Relay Proxy:

LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
  .mobileKey("example-mobile-key")
  .serviceEndpoints(
    Components.serviceEndpoints()
      .relayProxy("https://your-relay-proxy.com:8030")
  )
  .build();

val ldConfig: LDConfig = LDConfig.Builder(AutoEnvAttributes.Enabled)
  .mobileKey("example-mobile-key")
  .serviceEndpoints(
    Components.serviceEndpoints()
      .relayProxy("https://your-relay-proxy.com:8030")
  )
  .build()

C++ (client-side)

Expand C++ code sample

To connect the SDK to the Relay Proxy, use RelayProxyBaseURL to set the base URI of your Relay Proxy:

auto config_builder = client_side::ConfigBuilder("example-mobile-key");
config_builder.ServiceEndpoints().RelayProxyBaseURL("https://your-relay-proxy.com:8030");
auto config = config_builder.Build();

To learn more, read ServiceEndpoints.

Electron

Expand Electron code sample

To connect the SDK to the Relay Proxy, set the streamUrl, baseUrl, and eventsUrl options to the base URI of your Relay Proxy:

const options = {
  streamUrl: 'https://your-relay-proxy.com:8030',
  baseUrl: 'https://your-relay-proxy.com:8030',
  eventsUrl: 'https://your-relay-proxy.com:8030'
};

import * as LDElectron from 'launchdarkly-electron-client-sdk';

const options: LDElectron.LDOptions = {
  streamUrl: 'https://your-relay-proxy.com:8030',
  baseUrl: 'https://your-relay-proxy.com:8030',
  eventsUrl: 'https://your-relay-proxy.com:8030',
};

Flutter

Expand Flutter code sample

To connect the SDK to the Relay Proxy, use the ServiceEndpoints configuration option to specify the base URI of your Relay Proxy:

final config = LDConfig(
  CredentialSource.fromEnvironment(),
  AutoEnvAttributes.enabled,
  serviceEndpoints: ServiceEndpoints.relayProxy('https://your-relay-proxy.com:8030')
);

To learn more, read serviceEndpoints.

iOS

Expand iOS code sample

To connect the SDK to the Relay Proxy, set the streamUrl, baseUrl, and eventsUrl properties to the base URI of your Relay Proxy:

var ldConfig = LDConfig(mobileKey: "example-mobile-key", autoEnvAttributes: .enabled)
ldConfig.streamUrl = URL(string: "https://your-relay-proxy.com:8030")!
ldConfig.baseUrl = URL(string: "https://your-relay-proxy.com:8030")!
ldConfig.eventsUrl = URL(string: "https://your-relay-proxy.com:8030")!

LDConfig *ldConfig = [[LDConfig alloc] initWithMobileKey:@"example-mobile-key" autoEnvAttributes:AutoEnvAttributesEnabled];
ldConfig.streamUrl = [NSURL URLWithString:@"https://your-relay-proxy.com:8030"];
ldConfig.baseUrl = [NSURL URLWithString:@"https://your-relay-proxy.com:8030"];
ldConfig.eventsUrl = [NSURL URLWithString:@"https://your-relay-proxy.com:8030"];

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly iOS SDK version 9.9 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read enableCompression and Configuring an SDK to use the Relay Proxy.

JavaScript

Expand JavaScript code sample

To connect the SDK to the Relay Proxy, set the streamUrl, baseUrl, and eventsUrl properties to the base URI of your Relay Proxy:

const options = {
  streamUrl: 'https://your-relay-proxy.com:8030',
  baseUrl: 'https://your-relay-proxy.com:8030',
  eventsUrl: 'https://your-relay-proxy.com:8030'
};

import * as ld from 'launchdarkly-js-client-sdk';

const options: ld.LDOptions = {
  streamUrl: 'https://your-relay-proxy.com:8030',
  baseUrl: 'https://your-relay-proxy.com:8030',
  eventsUrl: 'https://your-relay-proxy.com:8030',
};

Node.js (client-side)

Expand Node.js (client-side) code sample

To connect the SDK to the Relay Proxy, set the streamUrl, baseUrl, and eventsUrl properties to the base URI of your Relay Proxy:

const options = {
  streamUrl: 'https://your-relay-proxy.com:8030',
  baseUrl: 'https://your-relay-proxy.com:8030',
  eventsUrl: 'https://your-relay-proxy.com:8030'
};

import * as ld from 'launchdarkly-node-client-sdk';

const options: ld.LDOptions = {
  streamUrl: 'https://your-relay-proxy.com:8030',
  baseUrl: 'https://your-relay-proxy.com:8030',
  eventsUrl: 'https://your-relay-proxy.com:8030',
};

React Native

Expand React Native code sample

To connect the SDK to the Relay Proxy, set the streamUri, baseUri, and eventsUri properties to the base URI of your Relay Proxy:

import { LDOptions } from '@launchdarkly/react-native-client-sdk'

let options: LDOptions = {
  streamUri: 'https://your-relay-proxy.com:8030',
  baseUri: 'https://your-relay-proxy.com:8030',
  eventsUri: 'https://your-relay-proxy.com:8030',
};

In version 6.x and earlier, the config properties were named streamUri, pollUri, and eventsUri. They were renamed to streamUrl, pollUrl, and eventsUrl in version 7.0. In version 10.0, they are named streamUri, baseUri, and eventsUri. To learn more, read LDOptions.

Roku

Expand Roku code sample

The Relay Proxy only works with the Roku SDK in polling modeThe Relay Proxy works when the Roku SDK is in polling mode only. You cannot use the Relay Proxy if the Roku SDK is in streaming mode.

To connect the SDK to the Relay Proxy, use the setStreamURI, setAppURI, and setEventsURI methods to specify the base URI of your Relay Proxy:

' for a legacy Roku application
config = LaunchDarklyConfig("example-mobile-key")

' for a SceneGraph Roku Application
config = LaunchDarklyConfig("example-mobile-key", CLIENT_SCENEGRAPH_NODE)

config.setStreamURI("https://your-relay-proxy.com:8030")
config.setAppURI("https://your-relay-proxy.com:8030")
config.setEventsURI("https://your-relay-proxy.com:8030")

Vue

The Vue SDK relies on the JavaScript SDK for Relay Proxy configuration. Set the service endpoint options in ldOptions to your Relay Proxy’s base URI when you install the plugin or create a provider.

Server-side SDKs

This feature is available for the following server-side SDKs:

.NET (server-side)
C++ (server-side)
Erlang
Go
Haskell
Java
Lua
Node.js (server-side)
PHP
Python
Ruby
Rust

.NET (server-side)

Expand .NET (server-side) code sample

To connect the SDK to the Relay Proxy, use the ServiceEndpoints builder method and Components.ServiceEndpoints().RelayProxy to specify the base URI of your Relay Proxy:

var config = Configuration.Builder("YOUR_SDK_KEY")
    .ServiceEndpoints(Components.ServiceEndpoints()
      .RelayProxy("https://your-relay-proxy.com:8030"))
    .Build();

C++ (server-side)

Expand C++ (server-side) code sample

To connect the SDK to the Relay Proxy, use RelayProxyBaseURL to set the base URI of your Relay Proxy:

auto config_builder = server_side::ConfigBuilder("YOUR_SDK_KEY");
config_builder.ServiceEndpoints().RelayProxyBaseURL("https://your-relay-proxy.com:8030");
auto config = config_builder.Build();
if (!config) {
   /* an error occurred, config is not valid */
}

LDServerConfigBuilder builder = LDServerConfigBuilder_New("YOUR_SDK_KEY");

LDServerConfigBuilder_ServiceEndpoints_RelayProxyBaseURL(builder, "https://your-relay-proxy.com:8030");

LDServerConfig config;
LDStatus status = LDServerConfigBuilder_Build(builder, &config);
if (!LDStatus_Ok(status)) {
     /* an error occurred, config is not valid */
}

To learn more, read ServiceEndpoints() in ConfigBuilder.

Erlang

Expand Erlang code sample

To connect the SDK to the Relay Proxy, set the stream_uri, base_uri, and events_uri properties to the base URI of your Relay Proxy:

ldclient:start_instance("YOUR_SDK_KEY", #{
  stream_uri => "https://your-relay-proxy.com:8030",
  base_uri => "https://your-relay-proxy.com:8030",
  events_uri => "https://your-relay-proxy.com:8030"
})

Go

Expand Go code sample

To connect the SDK to the Relay Proxy, use the Config.ServiceEndpoints property and ldcomponents.RelayProxyEndpoints() to specify the base URI of your Relay Proxy:

// To use the Replay Proxy in proxy mode for both streaming and events:

config := ld.Config{
    ServiceEndpoints: ldcomponents.RelayProxyEndpoints(
      "https://your-relay-proxy.com:8030"),
}

// Alternatively, to use the Relay Proxy in proxy mode for streaming,
// but send events directly to LaunchDarkly, use:
config := ld.Config{
    ServiceEndpoints: ldcomponents.RelayProxyEndpointsWithoutEvents(
        "https://your-relay-proxy.com:8030"),
}

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Go SDK version 7.6 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read EnableGzip and Configuring an SDK to use the Relay Proxy.

Haskell

Expand Haskell code sample

To connect the SDK to the Relay Proxy, use configSetStreamURI, configSetBaseURI, and configSetEventsURI to specify the base URI of your Relay Proxy:

{-# LANGUAGE OverloadedStrings #-}

import LaunchDarkly.Server.Config

import Data.Function ((&))

config :: Config
config = (makeConfig "YOUR_SDK_KEY")
    & configSetStreamURI "https://your-relay-proxy.com:8030"
    & configSetBaseURI "https://your-relay-proxy.com:8030"
    & configSetEventsURI "https://your-relay-proxy.com:8030"

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Haskell SDK version 4.4 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read configSetCompressEvents and Configuring an SDK to use the Relay Proxy.

Java

Expand Java code sample

To connect the SDK to the Relay Proxy, use the serviceEndpoints builder method and Components.serviceEndpoints().relayProxy to specify the base URI of your Relay Proxy:

LDConfig config = new LDConfig.Builder()
  .serviceEndpoints(Components.serviceEndpoints()
    .relayProxy("https://your-relay-proxy.com:8030"))
  .build();

Lua

Expand Lua code sample

To connect the SDK to the Relay Proxy, use the serviceEndpoints property to specify the base URLs:

local config = {
    serviceEndpoints = {
      streamingBaseURL = "https://your-relay-proxy.com:8030",
      pollingBaseURL = "https://your-relay-proxy.com:8030",
      eventsBaseURL = "https://your-relay-proxy.com:8030"
    }
}

To learn more about the configuration options, read clientInit.

Node.js (server-side)

Expand Node.js (server-side) code sample

To connect the SDK to the Relay Proxy, set the streamUri, baseUri, and eventsUri properties to the base URI of your Relay Proxy:

import * as ld from '@launchdarkly/node-server-sdk';

const options: ld.LDOptions = {
  streamUri: 'https://your-relay-proxy.com:8030',
  baseUri: 'https://your-relay-proxy.com:8030',
  eventsUri: 'https://your-relay-proxy.com:8030',
};

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Node.js (server-side) SDK version 9.8 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read enableEventCompression and Configuring an SDK to use the Relay Proxy.

PHP

Expand PHP code sample

To connect the SDK to the Relay Proxy, set the base_uri and events_uri properties to the base URI of your Relay Proxy:

$client = new LaunchDarkly\LDClient("YOUR_SDK_KEY",
    [ "base_uri" => "https://your-relay-proxy.com:8030",
      "events_uri" => "https://your-relay-proxy.com:8030" ]);

There is not a streaming service for the PHP SDK.

Python

Expand Python code sample

To connect the SDK to the Relay Proxy, set the stream_uri, base_uri, and events_uri properties to the base URI of your Relay Proxy:

config = Config(sdk_key='YOUR_SDK_KEY',
  stream_uri="https://your-relay-proxy.com:8030",
  base_uri="https://your-relay-proxy.com:8030",
  events_uri="https://your-relay-proxy.com:8030")

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Python SDK version 9.5 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, set enable_event_compression in the ldclient.config module and read Configuring an SDK to use the Relay Proxy.

Ruby

Expand Ruby code sample

To connect the SDK to the Relay Proxy, set the service endpoints to the base URI of your Relay Proxy:

config = LaunchDarkly::Config.new(
  stream_uri: "https://your-relay-proxy.com:8030",
  base_uri: "https://your-relay-proxy.com:8030",
  events_uri: "https://your-relay-proxy.com:8030")

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Ruby SDK version 8.7 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read compress_events and Configuring an SDK to use the Relay Proxy.

Rust

Expand Rust code sample

To connect the SDK to the Relay Proxy, use the ConfigBuilder and ServiceEndpointsBuilder to specify the base URI of your Relay Proxy:

let config = ConfigBuilder::new("YOUR_SDK_KEY")
    .service_endpoints(
        ServiceEndpointsBuilder::new().relay_proxy("https://your-relay-proxy.com:8030"),
    )
    .build();

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Rust SDK version 2.4 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read compress_events and Configuring an SDK to use the Relay Proxy.

​Client-side SDKs

​.NET (client-side)

​Android

​C++ (client-side)

​Electron

​Flutter

​iOS

​JavaScript

​Node.js (client-side)

​React Native

​Roku

​Vue

​Server-side SDKs

​.NET (server-side)

​C++ (server-side)

​Erlang

​Go

​Haskell

​Java

​Lua

​Node.js (server-side)

​PHP

​Python

​Ruby

​Rust

Client-side SDKs

.NET (client-side)

Android

C++ (client-side)

Electron

Flutter

iOS

JavaScript

Node.js (client-side)

React Native

Roku

Vue

Server-side SDKs

.NET (server-side)

C++ (server-side)

Erlang

Go

Haskell

Java

Lua

Node.js (server-side)

PHP

Python

Ruby

Rust