All Collections
4. Installing the MySQL Server Relay
4. Installing the MySQL Server Relay

The MySQL Server Relay provides access to a MySQL Server on-premise system .

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

Creating a Relay

Create a new Relay by logging into a Synatic Organization. To create a Relay, follow these instructions:

1. Create a new Relay in your solution by clicking the three menu dots (โ‹ฎ) adjacent to the new solution name (1).

2. From, there click the Create button > adjacent to your new solution (2) in the sidebar to expand it.

3. Select Relay from the options provided to create a new Relay (3).

When you create a Relay, the New Relay popup will appear, as shown in the image below.

4. Provide a Relay Name as highlighted in the below page.

5. Click the Add Endpoint button as highlighted in the image below.

6. Click on the icon in the Select Connection Type field as shown in the image below to select your on-premise system.

7. Search or select a connection type by clicking the connector icon. In this example, the My SQL Server connection type is selected.

8. Provide an Endpoint Name. This is required for the Relay. To identify the Endpoint, a meaningful name and description can be provided as illustrated in the page below.

Delete an Endpoint โ€“ Delete the Endpoint currently being used by clicking the Delete Endpoint text button.

Add Endpoint โ€“ Connect to additional Endpoints by clicking the Add Endpoint button.

9. Click the Save button.

10. Copy the generated Relay Key and keep it somewhere. It will be needed later on during the configuration. Use the highlighted icon to copy the key

Once the Relay has been created, download the Relay Certificate and Relay Manager.

Installing the Relay Manager

1. Run the SynaticQBRelaySetup.msi to install the Relay Manager.

2. Click Next and accept the defaults. Once installed, the Relay Manager can be started from the Windows Start menu.

3. Search for the Synatic Relay Manager application that is installed on the server where the relay is. Run it as an administrator to open it.

4. Click on File and create a New Relay.

5. Provide the License Key, the downloaded Relay Certificate, and Endpoints as shown in the image below.

6. Save the config and then test the connection.

7. Once successful, start the Relay.

8. Wait a few minutes for the relay to refresh and show a successful last heartbeat heartbeat. Test the Relay from Synatic once it has been installed. The Heartbeat outlined in the image below shows that the Relay is connected and running successfully.

Did this answer your question?