.. |product| replace:: VMware Workstation Pro VMware Workstation Pro ====================== .. note:: Please note first: since VMware/VirtualBox is a type-2 hypervisor, it needs to run on top of an operating system and requires access to hardware virtualization extensions, such as Intel VT-x or AMD-V. Therefore, your computer needs to be bare metal. Before using VMware/VirtualBox, please check whether your computer/server has been virtualized. For methods, please refer to https://www.narenvadapalli.com/blog/finding-linux-machine-vm-or-baremetal/ . Installation of VMware Workstation Pro -------------------------------------- 1. Download |product| from the `official website `_. The version we are using is 17.5.1. For systems with Apple chips, you should install `VMware Fusion `_. 2. Install |product| - `On Linux `_ : Run the following command in your terminal, where ``xxxx-xxxxxxx`` represents the version number and internal version number. .. code-block:: sh sudo sh VMware-Workstation-xxxx-xxxxxxx.architecture.bundle --console .. note:: You need to fill the activation key during the installation process when prompted. - `On Windows `_ : Ensure that you're logged in as either the Administrator user or as a user who belongs to the local Administrators group. If you're logging in to a domain, make sure your domain account has local administrator privileges. Proceed by double-clicking the ``VMware-workstation-xxxx-xxxxxxx.exe`` file. Be aware that you might need to reboot your host system to finalize the installation. .. note:: You need to fill the activation key during the installation process when prompted. - `For systems with Apple chips `_ : Double-click the ``VMware-Fusion-xxxx-xxxxxxx.dmg`` file to open it. In the Finder window that appears, double-click the 'Install Fusion' icon. When prompted, enter your administrator username and password. .. note:: You need to fill the activation key during the installation process when prompted. 3. Verify the successful installation by running the following: .. code-block:: sh vmrun -T ws list If the installation along with the environment variable set is successful, you will see the message showing the current running virtual machines. Troubleshooting --------------- If after installing VMware you still cannot use it (e.g., the `vmrun` command fails as indicated by an error, similar to `Issue 42 `_ ), please try installing `open-vm-tools` on your host machine. To install `open-vm-tools`, follow these steps: **On Ubuntu/Debian for example:** .. code-block:: sh sudo apt update sudo apt install open-vm-tools open-vm-tools-desktop After installing `open-vm-tools`, restart your system and try using VMware again. As a final solution, consider reading the `code of auto-installation `_ and debug to find the specific line. Customizing the VM Image ------------------------ If you want to customize the client machine image (e.g., adding additional tools, software, or configurations), you can modify the VM image directly using VMware: 1. **Configure for GUI access**: Set ``headless=False`` when initializing the DesktopEnv to enable the VMware GUI interface. 2. **Access the VM**: The VM will open in VMware's graphical interface on your local computer, allowing you to interact with it directly. 3. **Make your customizations**: - Install additional software packages - Configure applications - Add custom tools or scripts - Modify system settings 4. **Save changes**: After completing your modifications, properly shut down the VM from within the guest OS. 5. **Prepare for reuse**: - Create a new ``init_state`` snapshot to save your customized configuration as the new initial state .. note:: Make sure the VM is properly shut down (not force-stopped) and complete the cleanup steps to ensure your customized image can be reused properly.