Prerequisites

Before moving forward, make sure you meet the following prerequisites. Here's what you need:

1. A device with Windows 10 64-bit either a physical one, a virtual machine or in a control hub server.
2. Docker and Docker Compose installed on Windows. If you need help follow docker installation guide(Windows). Similarly, you can follow the docker-compose installation tutorials on Windows. Some knowledge of Docker and Docker Compose is good to have.
3. Here we use Windows 10 Home Single Language, OS 19043.1165, with 12.00 GB system RAM.

Step 2: Run Docker

1. Install WSL 2 Linux kernel as prompt.
2. Restart after installation.

   The Docker starts automatically after reboot.

3. Click Start to start Docker Desktop.
4. Typing cmd to Windows search bar and choose Command Prompt from the folder group.
5. Verify that Docker Engine is installed correctly.

   docker run hello-world

The output indicates that Docker in working correctly:

Step 3: Install Control Hub on Docker

1. To load Control Hub to Docker, you can run docker image load.

   docker image pull magewell/control-hub:2.1.51

   The result as follows.

2. Check Control Hub image in Docker > Images.
   
3. To start your Control Hub image, save Control Hub data and specify ports for each protocol, you can run docker run.
   

   Specify separate NFTS drives for the data and logs to make sure that the services can work.

   We recommended that you store all your data on the D drive or other data drive instead of the C drive. And make sure the specified ports are not occupied. If any port is occupied, you can change the number or the range.
   In this case, we will create a d:\data folder for Control Hub configuration data, a d:\log folder for Control Hub logs. Use port 80 for HTTP, 1935 for RTMP, 443 for HTTPS, 7900-8000 for udp (SRT services). And the image file is magewell/control-hub.

   docker run --name control-hub -it -v d:\data:/data -v  d:\log:/log -p 80:80 -p 1935:1935 -p 443:443 -p 7900-8000:7900-8000/udp -v //var/run/docker.sock:/var/run/docker.sock --restart unless-stopped -d magewell/control-hub:2.1.51

4. Check Control Hub in Docker > Containers.

Step 4: (optional) Update Control Hub

The Docker must be running and Control Hub must be deployed when updating Control Hub.

• If the current version is 2.1.49 or higher, the Control Hub supports online upgrading. You can update to the latest detected version under "Settings > Upgrade > Online Update".
• If the current version is below 2.1.49, please follow the steps below to upgrade.

  Here takes update Control Hub to 2.0.85 version as an example to illustrate the upgrade method.

  1. Find the update_control_hub.bat in /data/script folder of Control Hub.

     If the update_control_hub.bat is missing, contact us.

  2. Open the Windows Terminal.

  3. To auto-download the update package, just drag and drop update_control_hub.bat file inside the Terminal window. The full path of the dragged will instantly appear.

     Or you can manually update Control Hub to a specified version, for example v2.0.85. First, obtain the target version number. Then enter the following objects into Terminal in the following order.

     1. drag and drop update_control_hub.bat.
     2. enter a space.
     3. enter the target version number.
     Terminal should display as follows:

     Check the target version of Control Hub after update. You can find the Control Hub version at the upper left after logged-in successfully.

Post Deployment

1. To access Control Hub: open your browser and input IP address of Windows device, and 80 the default HTTP with the form as http://IP address.
   Then you should see a screen as the figure below.
   The default admin username and password both are Admin, case-sensitive. After the initial login, we highly recommended that you secure access by changing the default password.

2. To connect your device to Control Hub, go to Add Devices to Control Hub Tutorial.