Set up your relay

Overview

After installing Devo Relay on your machine, you must set up your relay and then activate it in your Devo domain. There are 2 different setup processes you can follow:

• Interactive relay setup - The Devo Relay CLI offers an interactive process that guides you through the required configuration of your new relay.

• Non-interactive relay setup - Alternatively, you can define a .properties file including the required relay settings and use it to set it up.

Before you begin

You should have the API Key and API Secret for your Devo domain handy when you start this process. To copy the API Key and API Secret, log in to your domain using the Devo web application, then go to the Access keys tab in Administration → Credentials. Learn more about this in Security credentials.

When using ELB, you also need to have the type and endpoint for a successful configuration. Learn more about ELB in Event Load Balancers. If you are not sure about how to determine this, contact the Devo support team.

Interactive relay setup

Follow these steps to set up a new relay through the interactive process of the Devo Relay CLI:

After activating the relay, it will stay in Applying config status for some time. The relay should turn to Active status in a few seconds. Learn more about the Devo Relay status workflow here.

Non-interactive relay setup

Instead of following the steps described above, you can define a file that includes all the required settings of your relay and use it to create it in the required domain. To do it:

Reconfigure your relay

You can always edit the settings of an already existing relay following these instructions:

Interactive setup

To reconfigure an existing relay through the Devo Relay CLI interactive process, repeat the setup process described above and enter the name of the relay you want to modify. At the end of the process, you'll be asked if you want to override the current relay with the new settings. Enter Y to do it.

If everything goes OK, you'll receive a confirmation message. Now you must activate the relay in the Devo app. Go to Administration → Relays and ELBs → Relays, find your relay on the list and click the Activate option in the ellipsis menu on the right side of the table.

Non-interactive setup

You can use a configuration file as described above to modify the settings of an already existing relay. To do it, enter the name of the relay you want to modify and the new settings, and save the file. Then, run one of the following commands in your machine (where <relayConfig.properties> is the name of the file including the relay settings):

devo-ng-relay-cli --force -autosetup <relayConfig.properties>

or

devo-ng-relay-cli --f -autosetup <relayConfig.properties>

If everything is properly set in your file, you'll receive a confirmation message. Now you must activate the reconfigured relay in the Devo app. Go to Administration → Relays and ELBs → Relays, find your relay on the list and click the Activate option in the ellipsis menu on the right side of the table.