Raspberry Pi

Prerequisites

Crux VPN is currently only validated with Raspberry Pi OS (64-bit) 6.12.y which can be downloaded using either the Raspberry Pi Imager or the official supported images.

Release date: November 19th 2024
System: 64-bit
Kernel version: 6.6
Debian version: 12 (bookworm)

Before installing the Crux VPN Agent, run the following command to update your local list of packages using /etc/apt/sources.list:

sudo apt update

The steps below summarize the installation process and assume you have already generated the required configuration files in the Web UI.

To set up a new agent for the host:

1. Create the agent configuration directory on the host:

 sudo mkdir -p /etc/cruxvpn/

2. If necessary move the configuration for any existing WireGuard interfaces you want the agent to monitor into the configuration directory:

 sudo mv wg0.conf /etc/cruxvpn/.

3. Download the cruxvpn.conf file generated within the Web UI, copy it to the host, and move it to the configuration directory:

 sudo mv cruxvpn.conf /etc/cruxvpn/.

4. Download the cruxvpn-setup.conf file generated within the Web UI, copy it to the host, and move it to the configuration directory:

 sudo mv cruxvpn-setup.conf /etc/cruxvpn/.

5. Download the Crux VPN Agent tarball:

 wget https://dl.sirius.computer/agents/cruxvpn-agent-latest.tar.gz

6. Copy the tarball to the host, and extract it:

 tar xf cruxvpn-agent-*.tar.gz

7. Run the install.sh script from the tarball as root, with the --install flag to activate the interactive installer:

cd cruxvpn-agent-*/
sudo ./install.sh --install

8. Enter y for all the prompts.

After installation, return to the host details page in the Web UI. The latest agent ping should now be visible.

To diagnose issues with the existing agent, try running the following command on the host:

sudo /opt/venvs/cruxvpn-agent/bin/cruxvpn-agent --test

For further assistance, head over to the troubleshooting section.