Skip to content

Set Up a Host

To set up a device to use Crux VPN, you must first add a host entry for it in the Crux VPN web UI. You can view the list of all your existing hosts on the Hosts page.

Set Up Page

The host's setup page will outline the steps needed to set up the host, and include links to the agent configuration and setup files needed to install the agent.

Follow these steps to go to the host's setup page:

  1. Click the Hosts link in the app header.
  2. Find the host in the list, and click its name to view its main status page.
  3. Click the "gear" icon on the right side of the Agent panel to view the host's setup page.

Configuration File

On the host's setup page, click the cruxvpn.conf link to download the agent configuration file. Copy this file to the host's configuration directory.

This configuration file contains the configuration settings the agent will use for this specific host.

Setup File

On the host's setup page, also click the cruxvpn-setup.conf link to download the agent setup file. Copy this file to the host's configuration directory.

The setup file contains a one-time setup code that the agent will use to authenticate with the Crux VPN API the first time it connects. The agent will delete the setup file after it uses it.

The one-time code in the setup file is good for three days. If the code already has been used or has expired, you can download a replacement setup file with a new one-time code by clicking the same cruxvpn-setup.conf link again.

Credentials File

As part of the setup process, the agent will generate a unique Ed25519 keypair that it will use to authenticate with on subsequent connections (note this keypair is distinct from any X25519 keys your host uses for WireGuard, and distinct from the secret key it uses for SKA-P). The agent will save this keypair in a file named cruxvpn-credentials.conf in the host's configuration directory.

Registration File

You must supply the agent registration file in order for the agent to automatically register a device with the Arqit SKA-Platform™ (SKA-P). Copy this file as cruxvpn-registration.conf to the host's configuration directory.

The registration file contains the SKA-P user credentials needed to register (or deregister) a device with SKA-P. See the Registration section of the Run an Agent documentation for details.

Configuration Directory

The Crux VPN agent configuration directory varies by platform.

Docker

When running the agent in a container, place the agent configuration files in a directory mapped to the container's own /etc/cruxvpn/ directory.

For example, if running the agent with the following docker run command:

$ sudo docker run \
    --cap-add NET_ADMIN \
    --volume /srv/containers/cruxvpn/conf:/etc/cruxvpn \
    ghcr.io/crux-comms/cruxvpn-agent

Place the agent configuration files in the following directory on the container host:

/srv/containers/cruxvpn/conf/

Linux

On Linux, place the agent configuration files in the following directory on the host:

/etc/cruxvpn/

Windows

On Windows, place the agent configuration files in the following directory on the host:

C:\Program Files\Sirius Computer\Crux VPN Agent\cnf\

Next Steps

Download the agent software and copy it to the host.