firezone/rust/gui-client/docs/vm_testing.md

Testing the Firezone GUI Client on an Ubuntu VM

WIP

(qemu VMs) Mounting the 9p share

From b27d541f09

1. sudo nano /etc/fstab
2. Append ``

(VirtualBox VMs) Mounting the vboxsf share

Shared folders are a pain on Ubuntu 20.04.

Just use ptth_file_server on the host and curl in the guest. Let it loop through the LAN.

Testing the Firezone Client on a Windows server VM

This assumes a Windows host. On macOS and Linux hosts, prefer UTM and qemu respectively.

Prepare VM

1. Download and install Oracle VirtualBox https://www.virtualbox.org/wiki/Downloads
2. Prepare a VM with 50 GB of hard drive, 2+ GB of RAM, and 2+ CPU cores (More resources will help Windows set up faster. We can reduce resources before testing Firezone)

Download VM image

Download the 64-bit ISO from https://www.microsoft.com/en-us/evalcenter/download-windows-server-2022

(Server 2019 requires a sign-up: https://info.microsoft.com/ww-landing-windows-server-2019.html)

You should get this file: SERVER_EVAL_x64FRE_en-us.iso

The Windows license is valid for 180 days

Install Windows Server

1. In VirtualBox, mount the ISO as a CD/DVD
2. Boot the VM and use F12, then 'c' to boot from CD/DVD
3. When Windows asks what version to install, choose "Windows Server 2022 Standard Evaluation (Desktop Experience)
4. Choose "Custom" to delete the old Windows install, if any, and re-install
5. If there's any partition from a previous install, delete and recreate it
6. Tell Windows to install on the primary partition

Windows first-time config

1. Assuming the host has a strong password, set the guest's admin password to just Password1!
2. Allow the PC to be "discoverable by other PCs and devices on this network", this might be needed for Firezone to work
3. In the Server Manager, click "Manage", click "Server Manager Properties", check "Do not start Server Manager automatically at logon", and click "OK". Close Server Manager.
4. Make any quality-of-life changes you want such as fixing the taskbar
5. Open https://ifconfig.net/ in Edge and clear out the Edge first-time setup
6. In edge://settings/privacy, disable secure DNS
7. Run Windows Update
8. In the VirtualBox menu, click "Devices", click "Insert Guest Additions CD image", and then install the VirtualBox guest additions, so you can drag-and-drop files into the VM easily.
9. Perform a clean shutdown from within the Windows VM.
10. In VirtualBox, take a snapshot of the VM and name it "Before Firezone" so you can roll back to this state after installing Firezone.

Testing Firezone

1. Copy-paste an MSI built from CI/CD into the VM and install Firezone
2. Test Firezone as usual