Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Before starting with Testrun, ensure you have the following hardware:
- 2x USB Ethernet adapter (one may be a built-in Ethernet port)
- Internet connection

**NOTE: Running in a virtual machine? Checkout the virtual machine documentation [here](/docs/virtual_machine.md).**

### Software

Ensure the following software is installed on your Ubuntu LTS PC:
Expand Down
36 changes: 36 additions & 0 deletions docs/virtual_machine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Virtual Machine

This guide will provide steps to use Testrun within a virtual machine in virtual Box (VMWare and other providers have not yet been tested). You should use this guide alongside the [Get Started guide](/docs/get_started.md) - only differences will be outlined in this guide.

## Prerequisites

### Hardware

Before starting with Testrun, ensure you have the following hardware:
- PC running any OS that supports Virtual Box
- 2x USB Ethernet adapter (built in ethernet connections are not supported)
- Internet connection

### Software

Ensure the following software is installed on the host PC:
- Virtual Box

Ensure the following software is installed on your virtual machine:
- Ubuntu LTS (22.04 or 20.04)
- Docker - installation guide: [https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)

## Installation

In addition to the install steps provided in the Get Started guide, the default user must be added to the sudo group.
1. Open a terminal and run ```sudo su``` to login as root (you will be prompted for your password).
2. Add the default user to the sudo group by running ```adduser {username} sudo```.
3. Restart the virtual machine.
4. Continue the installation as per the Get Started guide.

## Start Testrun

Attaching USB ethernet adapters is different when working in a Virtual Machine.
1. Ensure the 2x adapters are attached to the host PC.
2. With the virtual machine running, right click the USB icon in the bottom right of the window.
3. Select the 2x ethernet adapter names and check that these two adapters have now appeared in the virtual machine.