Skip to content

Examples by Protocol

A create example for every protocol, grouped by kind. Fields are documented in the Payload reference; for a user / auditor / admin walkthrough see Roles.

Every example creates the checkout with broker-bridge-api.sh, the helper that ships in the Bridge image with the broker at /opt/britive-broker/scripts/broker-bridge-api.sh.

Run it on the orchestrator (or the single container), where BRIDGE_API_URL and BRIDGE_CLUSTER_TOKEN are already set. From anywhere else, add --api-url https://<bridge> and --cluster-token <token> (and --ca-cert to verify TLS). Examples call it as broker-bridge-api.sh for brevity - use the full path above or add it to your PATH. checkout-create --stdin reads the payload from a pipe instead of a file.

How users connect

Creating the checkout is the same for every protocol; how the user reaches the target depends on the modes you’ve enabled (see the Protocol Reference).

  • Native - the user points the client they already use at the Bridge’s port for that protocol, authenticating as <britive-user>%<target-host>. The picker shows the exact address, username, and a ready-to-run command for each checkout - for example:

    terminal - representative native SSH connect
    ssh -p 22 'alice@corp%10.0.4.21'@bridge.example.com
  • Browser - the user clicks Connect in the picker, or opens https://bridge.example.com/connect?transaction_id=<transaction_id>; a recorded session opens in a new tab with nothing to install.

The mode notes on each example page show what applies to that protocol.

Pick a protocol

Last updated on