Follow the steps below to install a relay on Linux OS:
Create Relay
To create a Relay, follow these steps:
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).
4. Provide a Relay Name as highlighted in the image below.
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 in this example.
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.
9. Click the Save button.
10. Copy the generated Relay Key and keep it somewhere safe. It will be needed later on during the configuration.
Setup Relay
1. Install Node 16.
2. Run sudo npm install pm2 -g.
3. Extract the relay zip (attached at the bottom of this article) in the desired folder.
4. Inside the newly extracted folder, run the command sudo npm i.
5. Copy the relay certificate file into the folder.
6. Edit config.json file and add endpoint configs (Below is an example, Add your Relay key from the Synatic Admin portal and specify the endpoints).
Test Relay
1. Run sudo node synatic-relay.js.
Once the relay test is successful, install a relay service to run the relay in the background and start it automatically on startup:
2. Run sudo pm2 startOrRestart relay-server.json.
3. Run sudo pm2 startup.
4. Run sudo pm2 save.