Articles in this section

Installing Match Studio on Windows with Docker

Avatar
Jason Stevens
  • Updated
Follow

Copyright © 2020 Basis Technology Corporation

This document is the confidential information of Basis Technology Corporation and may not be disclosed or reproduced in whole or in part without the express written consent of Basis Technology Corporation.

“Basis Technology” is a trademark of Basis Technology Corporation. Reg. USPTO, Canada, EU, Australia and Japan. “Rosette” is a trademark of Basis Technology Corporation. Reg. USPTO, EU and Japan

Some products listed in Basis Technology Corporation documentation are claimed as trademarks by various manufacturers and sellers. When Basis Technology Corporation was aware of a trademark claim, the designated trademarks are printed in capital letters or initial capital letters.

U.S. Government Rights. This software is commercial computer software owned by Basis Technology Corporation. In accordance with DFARS 48 CFR 227-7202-1 and FAR 48 CFR 27.405-3(a), its use, reproduction, and disclosure by the Government is subject to the terms of Basis Technology's standard software license agreement and as may be set forth in the applicable Government Contract. Copyright © 2020 Basis Technology Corporation. All rights reserved. Licensor/Contractor: Basis Technology Corporation, One Alewife Center, Cambridge, MA 02140, USA. Basis Technology Corp. One Alewife Center Cambridge, MA 02140 T 617.386.2000 F 617.386.2020 E support@rosette.com

About Basis Technology

Verifying identity, understanding customers, anticipating world events, uncovering crime. For over twenty years, Basis Technology has provided the underlying analytical components enabling businesses and governments to tackle some of their toughest problems. Our Rosette text analytics platform employs a hybrid of classical machine learning and deep neural nets to extract meaningful information from unstructured data. Autopsy, our digital forensics platform, and Cyber Triage, our incident response tool, serve the needs of law enforcement, national security, and legal technologists with over 5,000 downloads every week. KonaSearch delivers natural language search of every field, object, and file in Salesforce all from the same index.

Company headquarters are in Cambridge, Massachusetts, with branch offices in Washington, London, Tel Aviv, and Tokyo. For more information, visit www.basistech.com.

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:

    • 64 bit processor with Second Level Address Translation (SLAT)

    • 4GB system RAM

    • BIOS-level hardware virtualization support enabled in the BIOS settings.

Verify the System Configuration

Verify Windows Version

Requirement: Windows 10 64-bit: Pro, Enterprise, or Education (Build 15063 or later)

  1. Start the Windows machine

  2. Click Start > Settings settings1.png.

    image11.png

  3. Select System

    image3.png

  4. Select About on the left hand side of the screen:

    image2.png

  5. Verify the Windows install meets the Match Studio requirements:

    • Installed RAM: 8GB or greater

    • System type: 64-bit operating system

    • Edition: Windows 10

    • OS build: 15063 or later

    image18.png
Verify Hyper-V is enabled

  1. Type Hyper in the Windows Search field

  2. If Hyper-V Manager is listed in the Best Match list, Hyper-V is enabled. Continue on to Install Docker.

  3. If Hyper-V Manager is not listed, verify that Virtualization is enabled. Enable it if necessary.

image27.png
Verify Virtualization

  1. Open task manager

    1. Right-click the Taskbar

    2. Click on Task Manager

    image25.png

  2. Select the Performance Tab on the top of the Task Manager. Look for Virtualization: enabled.

    image24.png

  3. Enable Virtualization if it is not Enabled.

Enable Virtualization

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.

  1. Save all your work and exit out of any open apps. Restart your computer.

  2. 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.

    image8.png

    This is the Dell BIOS loading screen

  3. 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.

    image1.png

    Example of a BIOS screen

    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.

  4. 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.

    image16.png

  5. After virtualization is enabled, restart the computer.

Enable Hyper-V

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.

  1. Open the Control Panel.

    1. Click on the bottom-left Start Button to open the Start Menu.

    2. Type control panel in the search box.

    3. Select Control Panel from the results.

  2. Select Programs

    image15.png

  3. 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.

    image23.png

  4. Select Ok.

  5. Restart the System.

  6. 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

Install Docker

The Docker website has the steps to install docker: https://docs.docker.com/docker-for-windows/install/.

  1. Sign up for Docker Hub at: https://hub.docker.com/signup

  2. Download Docker Desktop with CLI for Windows.

  3. Right click on the Docker for WIndows Installer, select Run as administrator.

    image7.png

  4. Leave the defaults as shown in this screen. We do not want to use Windows containers; Match Studio runs on Linux containers.

    image6.png

  5. If all the requirements have been met, you will see the following successful installation screen:

    image13.png

Docker will restart if required to enable Hyper-V.

Configure Docker

Once Docker is installed, it must be configured to run Match Studio.

Docker Settings:

  • Memory: 8 GB or higher

  • CPU: 2 or higher

  • Disk image max size: 50 GB or higher

  1. Double-click on the Docker icon to open the Docker for Windows application:

    image20.png

    You will see a pop up indicating that Docker is starting. Once Docker starts you will see the following screen:

    image10.png

  2. Right-click on the Docker whale in the system tray of the task bar and select the “Settings” option

    image19.png

  3. Click on the Advanced section. Update the following settings:

    • Memory: 8 GB or higher

    • CPU: 2 or higher

    • Disk image max size: 50 GB or higher

    image17.png

  4. Select Apply. Docker will restart.

  5. Click on Shared Drives. Share the C drive with Docker:

    image14.png

  6. Apply the changes.

Docker is ready for use.

Install Match Studio

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.

  1. Verify that you have the Match Studio zip file and the rlp-license.xml license file.

  2. Unzip the Match Studio zip file.

  3. Copy the file rlp-license.xml file to match_studio/bt_roots/licenses

    image12.png

  4. Run Command Prompt as Administrator

    1. Select Start.

    2. Type command.

      You'll see Command Prompt listed as the main result.

    3. Right-click on that result and choose "Run as administrator".

    image9.png

  5. Navigate to the match_studio folder.

    image5.png

  6. Enter docker-compose up to start Match Studio.

  7. 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.

    image26.png

    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)

  8. 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.

    image21.png

Comments

0 comments

Article is closed for comments.





Powered by Zendesk