Creating a Relay

Create a relay when you need access to a network segment where direct ingress is not possible or desirable.

A Relay creates connectivity to your datasources, while maintaining the egress-only nature of your firewall. Relays are the only things that can speak to your databases, mediating the connection between them and the SDM public relay pool (or your Gateways). Relays use a statically-compiled binary, optionally wrapped in a Docker container.

To create redundancy, you should deploy two relays (per firewalled/VPC region).

Note: If you will be deploying your relay in a Docker container, please follow the steps in the Docker Relay Guide.

When installing a relay or gateway, do not use the root user. Please use an ordinary privileged user and leverage sudo.

How to deploy a standard relay

  1. Generate a relay token. Log into the Admin UI and select Gateways on the left navigation bar. Click on the add relay button in the upper right, and a box will pop up. You can rename the relay here, or do it later. Click on create and the relay token will appear onscreen.

    New Relay

    Copy the relay token and put it aside, being careful to capture every character. You will need it again in step eight.

    Note: See sdm relay create if you want to generate a token via the CLI.

  2. Set up a 64-bit Linux instance that will run the relay. If you have two relays, you need two instances. Machines should have at least 2 CPUs and 4 GB of memory.

  3. Turn SE Linux off if it is running.

  4. Login to the relay instance and download the SDM binary:

    $ curl -J -O -L

  5. Unzip it:

    $ unzip

  6. Install the relay:

    $ sudo ./sdm install --relay

    Note: The installer must be run by a user that exists in the /etc/passwd file. Any users remotely authenticated, such as with LDAP or an SSO service, may fail to complete the installation.

  7. You will be prompted for the relay token you created in Step 1. Paste it in. It will not echo back to you for security purposes.

  8. Turn SE Linux on if you disabled it in step three.

  9. Login to the Admin UI and hard refresh. The Gateways section will appear on the left hand navigation. In that section, the relay you created should appear Online, with a heartbeat.

If you have multiple relays to create, follows steps 1 - 8 for each relay.

If any errors occur, please copy them into an email and send to