# VMware

{% embed url="<https://www.youtube.com/watch?t=3s&v=TD_Gr38HOsU>" %}

### 1. Preparation:

{% stepper %}
{% step %}
**Download the** CUBE OS **image**

Visit this [repo](https://github.com/eWeLinkCUBE/CUBE-OS/releases/latest) to download the latest `.vmdk`image. Please extract the image after downloading.
{% endstep %}

{% step %}
**Install VMware**

Download and install a virtual machine manager, with [VMware Workstation](https://www.vmware.com/products/desktop-hypervisor/workstation-and-fusion) being recommended.

> Have other virtual machine managers? The following steps can theoretically be used as well.\
> Unfamiliar with virtual machines and owning a Raspberry Pi? You can choose to install CUBE OS on a [Raspberry Pi](/getting-started/quickstart/raspberry-pi.md). \
> If none of these options are viable, you can purchase an [iHost](https://sonoff.tech/products/sonoff-ihost-smart-home-hub/58) with built-in CUBE OS from the SONOFF official website or platforms like Amazon.
> {% endstep %}

{% step %}
**Zigbee Adapter (Optional)**

If you need to add Zigbee devices, prepare a Zigbee Dongle. Tested Zigbee Dongles include:

> SONOFF ZBDongle-MAX\
> SONOFF ZBDongle-PMG24\
> SONOFF ZBDongle-LMG21\
> SONOFF ZBDongle-E\
> SONOFF ZBDongle-P\
> [Others listed](https://darkxst.github.io/silabs-firmware-builder/) by developer @darkxst&#x20;

{% hint style="info" %}
For more information on Zigbee configurations and compatibility, please refer to this [guide](/compatibility-check/zigbee.md).
{% endhint %}
{% endstep %}
{% endstepper %}

### 2. Create a Virtual Machine

{% stepper %}
{% step %}
Launch VMware, Select “Create a New Virtual Machine” <img src="/files/Dt2E1TTc96VimiKoMTPL" alt="" data-size="line">.

<div align="left"><figure><img src="/files/WQtHG9QPJQa9E1yWuZtw" alt="" width="375"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
Choose **Custom**, click **Next**. Hardware-**Workstation 17.5 or later,** click **Next.**\
![](/files/1QPdwNm8ttJKaxxsb3Od)![](/files/fv8lF2n0DVmzS8WQwAf5)
{% endstep %}

{% step %}
Choose **I will install the operating system later**, click **Next**.![](/files/3ekdrbkocuNFwvjF7ode)
{% endstep %}

{% step %}
Select **Linux > Other Linux 6.x kernel (64-bit)** as the guest operating system type.![](/files/C6ryBw3xNr8NKF6B4zfS)
{% endstep %}

{% step %}
Name the VM as **CUBE OS** and choose a storage location.![](/files/obnt00ign9r7Qhtzh470)
{% endstep %}

{% step %}
System Resources:

* **Processors**: 2 cores
* **Memory**: 4096MB (4GB) or more\
  ![](/files/HO3u94GJT5odN8gYmZns)![](/files/Y6tWTGPUXiFmqZGbhivl)
  {% endstep %}

{% step %}
Network / I/O Controller Types:

* Set **Network Adapter** to **Bridged** mode (important for LAN access and discovery).
* Set **Controller Type** to **LSI Logic** (required for compatibility with the virtual disk).![](/files/UPx3rYQZZfNVBcReQL7Q)![](/files/MjrwNfdVDJ7jKHjfFU8K)
  {% endstep %}

{% step %}
Select a Disk Type **SCSI(Recommended), Use an existing virtual disk**.

![](/files/B14h4eYbg3cTJxpEiWZV)![](/files/c6Zs2AM8At2Ku6LB8hnM)

{% endstep %}

{% step %}
Click **Browse**, then select the CUBE OS `.vmdk` and **Keep Existing Format**.![](/files/F6Zir4sAEB2XUY0UQKj8)![](/files/rdspYd9HJmcF912kj2Mn)
{% endstep %}

{% step %}
Click “Finish” to create the virtual machine.
{% endstep %}
{% endstepper %}

### 3. Configure the Virtual Machine

{% stepper %}
{% step %}
Select the created virtual machine and click the “Settings” ![](/files/chbff7DLftkcF1wILBdb) button.![](/files/AGPEyDDiiqQEHy2VFgAU)
{% endstep %}

{% step %}
Under the “Network” tab, confirm the network connection as “**Bridged**” and select **Replicate physical network connection state**.

<img src="/files/RF0CZdmbX58AEfdvgBGF" alt="" data-size="original">
{% endstep %}

{% step %}
Under “Options”-“Advanced” tab, set **Firmware type** to **UEFI**. ![](/files/uDDbJxFUYDVOoOKhh5aS)
{% endstep %}

{% step %}
**Optional:** If using a Zigbee USB dongle, ensure **USB Controller** is added. Under **USB Controller**, enable **Show all USB input devices.**

![](/files/bMmDItxspJahsRoHCTtd)
{% endstep %}

{% step %}
Click “OK” to save the configuration.
{% endstep %}
{% endstepper %}

### 4. Boot CUBE OS

{% stepper %}
{% step %}
Start the virtual machine.
{% endstep %}

{% step %}
Wait a few moments for CUBE OS to initialize. Monitor the boot screen until the boot is complete.

![](/files/ooXXlbvBBfxIkch1GV2Y)
{% endstep %}

{% step %}
Once completed, you will see the CUBE OS' IP displayed on the screen. Use this IP address or [cube.local](http://cube.local) to access the CUBE OS Web management page.

<img src="/files/f31WkLzYy3SKMTGWoLFY" alt="" data-size="original">
{% endstep %}

{% step %}
Upon successful access, a short ID can be viewed on the settings page. Subsequently, access the CUBE OS Web management page using `cube-{short id}.local`, which is useful for differentiating multiple CUBE OS instances on the same local network.

<img src="/files/3xHezvHm3zy90J9LazfZ" alt="" data-size="original">
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cube.ewelink.cc/getting-started/quickstart/virtual-machine/vmware.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.