Rosette Match Studio Windows Install Guide
This is an installation guide for running Match Studio on Windows. Since Match Studio runs on Docker containers, this guide steps you through configuring your machine to run Docker and Match Studio. Once your machine is configured, you can install Docker, and then Match Studio.
Important
This guide is only for Windows 10 and not Windows Server
Rosette Match Studio Requirements
Docker for windows installed
Rosette Match Studio zip file
RLP license file (rlp-license.xml)
8GB or more of RAM available for Docker
Chrome or Firefox web browser.
Docker Desktop on Windows Requirements
Windows 10 64-bit Pro, Enterprise, or Education (Build 15063 or later).
Hyper-V and Containers features must be enabled.
-
Hyper-V hardware requirements:
Verify the System Configuration
Requirement: Windows 10 64-bit: Pro, Enterprise, or Education (Build 15063 or later)
Start the Windows machine
-
Click Start > Settings 
.
-
Select System
-
Select About on the left hand side of the screen:
-
Verify the Windows install meets the Match Studio requirements:
Verify Hyper-V is enabled
Type Hyper in the Windows Search field
If Hyper-V Manager is listed in the Best Match list, Hyper-V is enabled. Continue on to Install Docker.
If Hyper-V Manager is not listed, verify that Virtualization is enabled. Enable it if necessary.
-
Open task manager
Right-click the Taskbar
Click on Task Manager
-
Select the Performance Tab on the top of the Task Manager. Look for Virtualization: enabled.
Enable Virtualization if it is not Enabled.
Note
Some PC's may not allow you to enable processor virtualization. These machines cannot run Match Studio. All newer machines have virtualization and it is usually enabled.
If you have a Dell, Gateway, HP, or similar PC, chances are good that virtualization is auto-enabled, meaning that you would not need to configure this option. Therefore, before enabling virtualization, verify if virtualization is enabled.
Caution
Be very careful editing the BIOS. Improper editing could lead to issues with the computer.
Save all your work and exit out of any open apps. Restart your computer.
-
When you see the BIOS loading screen, hit the Setup key, which in most cases is an F-command key such as F2, F5, or F12. The BIOS screen appears before the Windows loading screen and likely only stays on-screen for a couple of seconds.
-
Once you hit the activator key, your computer will display a very basic screen, showing a limited list of options. This list will have a number of options that you may never heard of. Common options include: CMOS features, Advanced BIOS features, Boot, Power Management, PC Health Status.
Examine the list options and see if you can find an option that mentions virtualization. The option should be under Processor, Chipset, Advanced CPU config, etc. If you do not see anything directly on the home screen, enter each individual listing and look for the virtualization option within other options.
-
The actual virtualization setting can be named VT-x, Intel VT-x, Virtualization Extensions, Intel Virtualization Technology, etc. Once you have found the virtualization option (if your motherboard BIOS has it), toggle it on/off simply by pressing Enter or the Arrow keys. The motherboard key will guide you through the process of changing specific values.
After virtualization is enabled, restart the computer.
This step is optional, as the Docker installation enables Hyper-V. If you have Docker installed and Hyper-V isn't enabled, follow these directions.
-
Open the Control Panel.
Click on the bottom-left Start Button to open the Start Menu.
Type control panel in the search box.
Select Control Panel from the results.
-
Select Programs
-
Select Turn Windows features on or off and check Hyper-V option. All components under Hyper-V should be selected. Select Hyper-V options if they aren't already selected.
Select Ok.
Restart the System.
Now when you search for Hyper-V Manager you will see it listed, as shown in the steps to check if Hyper-V is enabled
The Docker website has the steps to install docker: https://docs.docker.com/docker-for-windows/install/.
Sign up for Docker Hub at: https://hub.docker.com/signup
Download Docker Desktop with CLI for Windows.
-
Right click on the Docker for WIndows Installer, select Run as administrator.
-
Leave the defaults as shown in this screen. We do not want to use Windows containers; Match Studio runs on Linux containers.
-
If all the requirements have been met, you will see the following successful installation screen:
Docker will restart if required to enable Hyper-V.
Once Docker is installed, it must be configured to run Match Studio.
Docker Settings:
-
Double-click on the Docker icon to open the Docker for Windows application:
You will see a pop up indicating that Docker is starting. Once Docker starts you will see the following screen:
-
Right-click on the Docker whale in the system tray of the task bar and select the “Settings” option
-
Click on the Advanced section. Update the following settings:
Select Apply. Docker will restart.
-
Click on Shared Drives. Share the C drive with Docker:
Apply the changes.
Docker is ready for use.
Note
You must be logged into Docker when installing Match Studio. You can login through the whale icon or enter docker login at the command prompt.
Verify that you have the Match Studio zip file and the rlp-license.xml license file.
Unzip the Match Studio zip file.
-
Copy the file rlp-license.xml file to match_studio/bt_roots/licenses
-
Run Command Prompt as Administrator
Select Start.
-
Type command.
You'll see Command Prompt listed as the main result.
Right-click on that result and choose "Run as administrator".
-
Navigate to the match_studio folder.
Enter docker-compose up to start Match Studio.
-
The docker-compose file under match studio will download all the docker images that Match Studio uses. You’ll see the docker images pulled in, then the containers starting. In about 5 minutes, Match Studio should be ready to use. The lines in highlighted in the log message below indicate Match Studio is ready to use.
Text:
ingest | 2019-08-27 21:34:21.309 INFO 12 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8081 (http) with context path ''
ingest | 2019-08-27 21:34:21.315 INFO 12 --- [ main] o.s.c.support.DefaultLifecycleProcessor : Starting beans in phase 2147483647
ingest | 2019-08-27 21:34:21.602 INFO 12 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8092 (http) with context path ''
ingest | 2019-08-27 21:34:21.604 INFO 12 --- [ main] c.r.i.ingest.IngestNodeApplication : Started IngestNodeApplication in 20.419 seconds (JVM running for 21.785)
-
Open a Chrome or Firefox web browser to http://localhost:8090 to start working on Match Studio. Currently Match Studio does not support the Microsoft Edge browser and Microsoft Internet Explorer.