LiftCanary

Advanced

Hybrid deployment

Keep visitor data in your own infrastructure: run the data plane, we run the control plane.

In hybrid deployment your visitors' data never leaves your infrastructure. You run the data plane: the collector that receives exposures and events, and the ClickHouse that stores them. LiftCanary runs the control plane: the dashboard, the API, the statistics and the visual editor. To show results, the control plane asks your data plane for aggregates (counts and sums per variation, step, segment or day) and never receives rows about visitors, which is also why an experiment's live log isn't available in hybrid. It's available on enterprise plans, under the Hybrid Deployment Terms.

What runs where#

Your infrastructure (data plane)LiftCanary (control plane)
SoftwareThe data plane image (collector) and ClickHouseDashboard, API, statistics, visual editor, datafile CDN
DataExposures, events, identity links, visitor ids and attributesYour configuration (flags, experiments, goals), your team's accounts, aggregated results while a page shows them
Visitors' browsers talk toYour collector (data-events-url) and its location endpoint (data-geo-url)The CDN for the snippet and the datafile (configuration only)

The datafile holds your flags and experiments, not personal data. The snippet file itself is loaded from our CDN, so that request reaches it like any static file; nothing about the visitor is stored there.

Set it up#

  1. Ask us to enable it

    We turn hybrid deployment on for your organization and give you access to the data plane image.
  2. Issue a license key

    Settings → Organization → Data plane → Issue license key (owners). It's shown once. It identifies your data plane and signs every request between the control plane and it.
  3. Start the data plane

    On a server or cluster you control, with Docker:

    Terminal
    # deploy/data-plane in the repository we share with you
    cp .env.example .env    # LICENSE_KEY, CLICKHOUSE_PASSWORD
    docker compose up -d

    Put HTTPS in front of port 4100, for example at https://lc.example.com. The data plane creates its tables in ClickHouse on start and needs to reach https://api.liftcanary.com (outbound) to look up SDK keys. It takes visitors' addresses (for rate limits) from the X-Forwarded-For header your proxy sets, so let only that proxy reach port 4100: a firewall rule, or BIND=127.0.0.1 when the proxy runs on the same machine. With nothing in front, set TRUST_PROXY=0.

  4. Connect it

    Back in Data plane: enter the address and save, then Check connection. It asks the data plane for a harmless aggregate, signed with your key.
  5. Point the snippet at it

    HTML
    <script src="https://cdn.liftcanary.com/sdk/v1/liftcanary.js" data-sdk-key="pk_…"
            data-events-url="https://lc.example.com" data-geo-url="https://lc.example.com/geo"></script>

    For the npm package and server SDKs, pass eventsUrl: "https://lc.example.com". From then on, results, goals, websites, usage and visitor requests in the dashboard come from your data plane.

What the control plane can ask#

The data plane answers a fixed list of operations, each signed (HMAC-SHA256 with your license key, valid for 5 minutes) and refused otherwise: experiment metrics per variation and per segment, the attributes seen in an experiment, funnel step counts, recent activity and event keys, page origins, monthly visitor counts, and, when your admins ask for it in the dashboard, one visitor's summary or deletion. There's no operation that runs arbitrary queries or returns rows.

License keys#

Issuing a new key revokes the old one at once: the data plane can no longer look up SDK keys, so it stops accepting events (answering 503, so browsers keep events and retry), and it refuses the control plane's requests. Set the new key and restart it to resume. Ending hybrid deployment revokes the key too; the data you stored stays with you.