Document toolboxDocument toolbox

Install the Relay on an Ubuntu box (v1.4.2)

Owned by Juan Tomás Alonso Nieto (Unlicensed)
Last updated: May 31, 2021
4 min read

This article takes you step by step through the installation of the Devo Scoja Relay on a machine running Ubuntu. We will install the most recent version of the Relay (v1.4.2) using a .deb package that resides in Devo public repository.

Machine hostname

The hostname of the machine on which you install the relay must not contain dots.

Relay migration

If you are using an old version of the Devo relay and want to migrate to the most recent version (v1.4.2), go to Relay migration to learn how to do it.

Before you begin

Make sure you can provide a machine with the following requirements:

Hardware

Minimum requirements:

  • 2 vCPU
  • Memory → 2 GB

  • Hard disk → The hard disk memory should be twice the required disk buffer.

    Hard disk memory

    Note that the hard disk memory should be calculated in relation to the data ingest. Higher volumes of data would allow you to handle potential long downtimes in the network better.

    Learn more about this in Relay buffers





Network

Ensure that the Devo Relay can access the following resources:

For USA users:

  • https://us.devo.com: 443
  • us.elb.relay.logtrust.net: 443

For EU users:

  • https://eu.devo.com: 443
  • eu.elb.relay.logtrust.net: 443 

For Canada users:

  • https://ca.devo.com: 443
  • ca.elb.relay.logtrust.net: 443 

These are the ports used by the Devo Scoja Relay:

  • Reserved inbound ports → 12999 to 13002 configured with default rules
  • Optional inbound ports → 13003 to 13030 reserved for custom rules

These ports should not be used by any other services.

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

Installing the Devo Scoja Relay

Follow these instructions to install the .deb package that contains the Devo Scoja Relay.

Note that the .deb package is certified for Ubuntu 18 (Bionic) but should work properly in other Linux distributions. 

  1. Import the Devo repository public key:

    wget -qO - http://packages.devo.com/PublicKey | sudo apt-key add -
echo "deb http://packages.devo.com/ bionic devo" | sudo tee /etc/apt/sources.list.d/devo.list

  2. Update the resources list.

    sudo apt-get update

  3. Install the relay package with this command:

    sudo apt-get install devo-scoja-relay

  4. The configuration utility will be launched, which takes you through the steps required to set up a secure connection with the Devo Cloud for your region.

    First, select the cloud region your Devo domain resides in, then press ENTER .

    If you select Manual to configure a private cloud location, additional steps request the following information before proceeding:

    - Your Devo web application URL (i.e. https://company.devo.com)
    - IP address of your Devo endpoint
    - Port to send to on your Devo endpoint 

    Now enter a name for the new relay. This is not the hostname; it's the relay name that will appear in the Devo web application in Administration → Relays.

    The relay name can contain a maximum of 50 characters and must not contain periods. You can use underscores and hyphens but other special characters are not allowed.

    Now enter the API Key for the Devo domain to which you will be forwarding events.

    Go to Administration → Credentials in the Devo web application to copy the API Key.

    Click Yes if the relay requires a proxy to reach the internet. If you do, you can enter the proxy address in the next screen. Otherwise, click No.

  5. Now you can activate the relay. Go to Administration → Relays and click the Activate button that appears in the new relay's row in the Relay list. 

To confirm that the relay is operating correctly, follow our procedure to send test events and make sure they are saved in your Devo domain. You can now start sending information from your data sources to the new Devo Relay and create the relay rules for event processing.

Reconfiguring the relay

To relaunch the configuration utility at any time after the installation, use the command:

dpkg-reconfigure devo-scoja-relay