# UGREEN NAS

## 1. Preparation

Please make sure your setup meets the following requirements:

{% stepper %}
{% step %}
**6GB RAM** installed (recommended) in your UGREEN NAS (4GB for the virtual machine running CUBE OS); Please contact UGREEN for upgrading guides if your unit only has 2GB or less memory.
{% endstep %}

{% step %}
Your NAS has an x86\_64 platform

{% hint style="info" %}
Currently, only x86\_64 architecture is supported by this installation method.

For ARM and other platforms, please turn to other devices and wait for future updates.
{% endhint %}
{% endstep %}

{% step %}
WAN access to download the virtual machine manager
{% 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 

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

## 2. Installation

{% stepper %}
{% step %}
Visit this [repo](https://github.com/eWeLinkCUBE/CUBE-OS/releases/latest) to download the CUBE OS image ending with `.vdi` 
{% endstep %}

{% step %}
 Access to UGREEN dashboard
{% endstep %}

{% step %}
Install `Virtual Machine Manager` from. Launch `Virtual Machine Manager` from the dashboard and switch to the Image page.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FHsFEaz6Sx3DxOUUquC7z%2Fimage.png?alt=media\&token=2c7e91ef-c51e-42be-8f1f-1e81e4f5332d)
{% endstep %}

{% step %}
Click **Create VM**, then select **Import Virtual Machine**. Choose **Import from Disk File**, then click **Next**.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2Fo5AVQqzUPE63tSpHAeVI%2Fimage.png?alt=media\&token=83132c5c-dfa7-4845-b3e4-987380915b72)
{% endstep %}

{% step %}
If this is your first time setting up, select **Upload image manually**.![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FYfCAEr90BYr9hztwThUl%2Fimage.png?alt=media\&token=e00f1e70-73dc-4d8b-aeab-18159795a03f)
{% endstep %}

{% step %}
Locate the downloaded CUBE OS `.vdi` file:

* You can upload it from your local device, or
* Select it from existing files on your NAS.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2F0KOOTjKxohLaKlZEjtA0%2Fimage.png?alt=media\&token=f0049de8-28ae-4dfe-8024-396dac5dfb1a)
{% endstep %}

{% step %}
After selecting the image, click **Confirm** to upload and convert the image.![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FhIFW0AzMkPR7WM79PNqY%2Fimage.png?alt=media\&token=d9de960e-4c65-4770-8c78-9013d1253a56)
{% endstep %}

{% step %}
Once imported, repeat the **Import Virtual Machine** process:

* The uploaded image will now appear in the dropdown list.
* Select it and click **Next**.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FYMnoxLGIvZTa9VLFugHT%2Fimage.png?alt=media\&token=07fa93f4-200d-4945-9e45-233013657717)
{% endstep %}

{% step %}
Choose a storage volume for the virtual machine and continue.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FKn2llmcYacrZcnBDehCE%2Fimage.png?alt=media\&token=e71e3204-22ae-4f3d-a624-3d504e9aa2d1)
{% endstep %}
{% endstepper %}

## 3. Configure Virtual Machine Settings

{% stepper %}
{% step %}
Basic Configuration:

* **System type**: Select **Other**
* **vCPUs**: 2 cores (or more if available)
* **Memory**: Allocate **4GB or more**

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FFzJWV9RbY8Uo7RbhNbja%2Fimage.png?alt=media\&token=fb7d73fc-358f-45a2-885e-c46473f9ce8f)
{% endstep %}

{% step %}
Network Configuration:

* Select **Bridge mode** (Do **not** use Host or NAT)

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FxoF7dgE8th3cPE1GV1IK%2Fimage.png?alt=media\&token=83b4e3dc-505c-4a00-9e29-c2ed29f2720b)
{% endstep %}

{% step %}
Under USB options, locate and add your Zigbee/Thread USB dongle:

* Click the **+** icon to assign the correct USB port.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FeAu8muLurbAXquGZPCmx%2Fimage.png?alt=media\&token=71cbf555-b9f5-4e92-bff1-bb7d63afda20)
{% endstep %}

{% step %}
Set **Bootstrap Type** to **UEFI**.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FI7nD0nNUV7MopdBrcPny%2Fimage.png?alt=media\&token=2cda692b-4308-404f-b02d-8e51b2e5685b)
{% endstep %}
{% endstepper %}

## 4. Booting CUBE OS

{% stepper %}
{% step %}
Back in the VM list, click **Start** to power on the virtual machine.![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FOAD7ykIrl115nlxCwX3h%2Fimage.png?alt=media\&token=f415c0db-9fca-47e8-bfbb-97b8e2b45b25)
{% endstep %}

{% step %}
Wait for a few minutes. Click **Connect** to view the VM console:

* If the CUBE OS welcome screen appears, the system has started successfully.![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2Fevgn8YMkIfIDSNTBn6S7%2Fimage.png?alt=media\&token=7f92ea14-58b7-4b8e-bd51-1484e00b09a5)
  {% endstep %}

{% step %}
Enter [cube.local](http://cube.local) on your browser to access the onboarding page. You can also access it via IP alternatively.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2F8L0fPypCix5FIElQ64lt%2FScreenshot%202024-11-18%20at%2016.33.08.png?alt=media&#x26;token=951e09b3-3e19-436d-b5a3-74bd60a5d5d1" alt="" data-size="original">

{% hint style="info" %}
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.
{% endhint %}
{% endstep %}
{% endstepper %}