Recommended specs: 64-bit 2-core CPU; 2GB of RAM. Recommended configuration is two separate Relay VM instances - listening on different LAN IPs; so you can hand these two DNS IPs out via DHCP.
Download one of the OVA file:
In order to use the VirtualBox image follow the below guidelines:
- Import the OVA file into VirtualBox.
- Change the VM to use a bridged network interface instead of NAT
- Change the default password using the following command:
- Edit the relay.conf file using the following command (See step 5 for some default values to edit):
sudo nano /etc/relay/relay.conf
- In relay.conf (found at the following location:
/etc/relay/relay.conf) set Secret Site Key and Name.Note1: The name needs to match the deployment name set in your dashboard.
Note2: To save the changes made within relay.conf use ctrl+o to write out then hit return to finalise the file name, you can then exit with ctrl+x.
- Run the below commands:
sudo systemctl enable docker.service
sudo systemctl start docker.service
- I would recommend a VM restart here.
- After restarting you can run the ifconfig command to make sure it is picking up the correct IP.
- Use a ping google.com to test connectivity (ctrl+c breaks out of the ping)
- You can confirm the status of the relays by using the following command:
sudo docker ps
- This instance should now be good to go.
By default, the VM runs two docker instances of relay which load balance traffic requests. Every hour a system cron job checks for a new docker container, and if it exists, updates one, followed by the other. This upgrade should be without interruption.
Any further questions reach out to email@example.com.