# Synology NAS

{% embed url="<https://youtu.be/coJYs-3Jnbo?si=idrpiu9LcMBNvHGa>" %}

## 1. Preparation

Please make sure your setup meets the following requirements:

{% stepper %}
{% step %}
**6GB RAM** installed (recommended) in your Synology NAS (4GB for the virtual machine running CUBE OS); Please contact Synology 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 %}

{% hint style="info" %}
You can refer to this official [document](https://kb.synology.com/en-me/DSM/tutorial/What_kind_of_CPU_does_my_NAS_have) to find the platform information for your Synology devices.
{% endhint %}
{% endstep %}

{% step %}
WAN access to download the virtual machine manager
{% endstep %}

{% step %}
Admin account to your Synology NAS
{% 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](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`&#x20;
{% endstep %}

{% step %}
&#x20;Access to Synology dashboard

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FCa0IDeHzIjTA8Rd9oO6h%2FScreenshot%202024-11-18%20at%2018.32.02.png?alt=media&#x26;token=b32de532-00c1-489d-a8ff-850048597771" alt="" data-size="original">
{% endstep %}

{% step %}
Install `Virtual Machine Manager` from the Package Center

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FLOTO9FerKCBLD37gkVST%2FScreenshot%202024-11-18%20at%2015.48.50.png?alt=media&#x26;token=78c23dc1-26e2-4edc-8954-06f3e5c522a4" alt="" data-size="original">
{% endstep %}

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

{% step %}
Enter the Disk Image tab, then click the `Add` button.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2Ffa4JCGio2dc60vxHK9hC%2FScreenshot%202024-11-18%20at%2016.03.24.png?alt=media&#x26;token=0d58f0cc-77ad-4cca-9577-3e3401bcc7da" alt="" data-size="original">
{% endstep %}

{% step %}
Follow the guide to upload the `.vdi` file you downloaded from the previous [step](#preparation).

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2F7pS58LLivDFVBhFEb7DY%2FScreenshot%202024-11-18%20at%2016.03.42.png?alt=media&#x26;token=9e495161-8dd2-4709-9966-d3e3f80e4ab1" alt="" data-size="original">
{% endstep %}

{% step %}
Wrap the steps and wait for it to be fully uploaded.
{% endstep %}

{% step %}
Switch to the `Image` tab and upload the .vdi file to your NAS. Please wait until it completes uploading.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2Fv6Xa2ENKjT8oeVwoLcqh%2FScreenshot%202024-11-18%20at%2016.03.42.png?alt=media&#x26;token=448cb518-5a2f-42e3-a9f1-7cdb3dd66ab6" alt="" data-size="original">
{% endstep %}

{% step %}
Switch to the `Virtual Machine` page and click on the dropdown icon next to the `Create` button and use `Import`.&#x20;

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FFJasCUhq06WNcc6QtGz7%2FScreenshot%202024-11-18%20at%2016.25.37.png?alt=media&#x26;token=7641c364-a15d-4989-bbe7-51c4bb8e2f01" alt="" data-size="original">
{% endstep %}

{% step %}
Select the `Import from disk images` option on the wizard.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FG425fdrrBq0WzAaomcEY%2FScreenshot%202024-11-27%20at%2015.01.10.png?alt=media&#x26;token=cb71379b-c00b-40c2-9cd1-28ced24a50f6" alt="" data-size="original">
{% endstep %}

{% step %}
Select the storage where you uploaded the virtual disk file.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FMxh732JOfTy0hO65gty6%2FScreenshot%202024-11-27%20at%2015.59.43.png?alt=media&#x26;token=293a0c5b-b690-463b-9494-7632a6a31d13" alt="" data-size="original">
{% endstep %}

{% step %}
Set the computational resources CUBE OS needs.

{% hint style="info" %}
**2 vCPUs and 4GB RAM are recommended for a better experience.**
{% endhint %}

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FTz4DyrcyFn8HWH9OGEzx%2FScreenshot%202024-11-18%20at%2015.49.44.png?alt=media&#x26;token=a3fe16ee-737a-4b18-90f3-15110bad7823" alt="" data-size="original">
{% endstep %}

{% step %}
Choose the virtual disk on the dropdown list.

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FNA2BMI9IWtylpKbLOeFg%2FScreenshot%202024-11-18%20at%2016.26.07.png?alt=media&#x26;token=c78da8b9-93d7-4010-a5c3-99abfa76847a" alt="" data-size="original">
{% endstep %}

{% step %}
⚠️ For `Other Settings`, choose `UEFI` in the `Firmware` option.

![](https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FnhGNpPACxWXjsZ0qbHOk%2FScreenshot%202024-11-18%20at%2016.26.38.png?alt=media\&token=a3556f9e-22d1-4352-92f3-4b0f1ed83c6e)
{% endstep %}

{% step %}
Optional: Plug in your Zigbee dongle to your NAS, and pass through the device to the virtual machine on this page.

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

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FqE93zoXS6o8CAgQrszM2%2FScreenshot%202024-11-18%20at%2016.26.38.png?alt=media&#x26;token=e4927b96-dee0-401f-8d0c-e3b619b2829b" alt="" data-size="original">
{% endstep %}

{% step %}
Assign management permission to your NAS accounts.
{% endstep %}

{% step %}
Final review of your configuration, check `Power on the virtual machine after creation` and click `Done`

<img src="https://67406449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCnF8kmk9yw3yiy2mRerq%2Fuploads%2FsOxapXaxEBj1cOf2EaP5%2FScreenshot%202024-11-18%20at%2016.26.51.png?alt=media&#x26;token=e0151607-b55d-4db3-a571-0747c702e04f" alt="" data-size="original">
{% endstep %}

{% step %}
Wait for a few minutes. 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 %}