Relay Deployment with VirtualBox

Article author
Liam Blake
  • Updated


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: 


Login Credentials

Username: dnsfilter

Password: ChangeMeNow!

Setup Guide

In order to use the VirtualBox image follow the below guidelines:

    1. Import the OVA file into VirtualBox.
    2. Change the VM to use a bridged network interface instead of NAT
    3. Change the default password using the following command:
    4. Edit the relay.conf file using the following command (See step 5 for some default values to edit):
      sudo nano /etc/relay/relay.conf
    5. 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.
    6. Run the below commands:
      sudo systemctl enable docker.service
      sudo systemctl start docker.service
    7. I would recommend a VM restart here.
    8. After restarting you can run the ifconfig command to make sure it is picking up the correct IP.
    9. Use a ping to test connectivity (ctrl+c breaks out of the ping)
    10. You can confirm the status of the relays by using the following command:
      sudo docker ps
    11. 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

Was this article helpful?

0 out of 3 found this helpful

Have more questions? Submit a request



Please sign in to leave a comment.