These are simple instructions for installing Match Studio on a single machine. For more information on installing and running Match Studio, see the included README. For information on using Match Studio when it is installed and running, access the Match Studio User Guide by selecting the Help tab or visiting the Rosette Text Analytics Support website.
The following files are included in the RMS shipment:
rosette-match-studio-dockerless-windows-<version>.zip: Windows version of Match Studio
rlp-license.xml: License file
RMS-installation-guide.pdf: This guide
Windows 10 or 11
-
Java 17 with JAVA_HOME and ES_JAVA_HOME set up as environment variables.
At least 16 GB of RAM
At least 32 GB of hard disk space
Google Chrome version 99.0.4844 or higher (recommended) or Microsoft Edge version 105.0.1343.33 (64-bit, official build) or higher
Admin permissions
Using Vault ensures that your Elasticsearch password will be encrypted in the database. If you do not use Vault, your Elasticsearch password will be saved as clear text.
Note
If you are using the basic dev mode of Vault, the external servers with authentication or APIs will need to be re-added when you restart Vault.
Install Vault.
Open a command line interface and launch Vault using the following command: vault server -dev -dev-root-token-id root.
Add the Environment variable: export VAULT_ADDR='http://127.0.0.1:8200.
Enable transit using the following command: vault secrets enable transit.
Create an encryption key ring called rms using the following command: vault write -f transit/keys/rms.
-
Create a policy file with a .hcl extension with the following content
path "transit/encrypt/rms" {
capabilities = [ "update" ]
}
path "transit/decrypt/rms” {
capabilities = [ "update" ]
}
Run the following command: vault policy write app-rms <filename>.hcl.
Create a token with the app-rms policy attached using the following command: vault token create -policy=app-rms.
Record the token value.
Using SSL ensures that your connection with the server is encrypted. To use SSL, you will need to have the following files ready during installation:
PKCS12 certificate (.p12, .pkcs12, .pfx)
Client certificate (.pem, .cert, .crt, .cer)
Client key (.pem, .key)
Open the command prompt as an administrator.
-
Extract the contents of rosette-match-studio-dockerless-windows-<version>.zip using the following command:
tar xf rosette-match-studio-dockerless-windows-<version>.zip
Navigate to the match-studio-<version> directory.
Run install_rms.bat. This script installs Rosette Match Studio and its dependencies.
When prompted, provide the location of the rlp-license.xml file.
When prompted, choose whether you want to enable Vault.
-
If you selected Yes:
When prompted, enter the token key. In this case it is "rms".
When prompted, enter the url for Vault. For example, if local, the URL will be http://localhost:8200.
When prompted, enter the token value you recorded in step 7 of the Set Up Vault section.
When prompted, choose whether you want to enable SSL.
-
If you selected Yes:
When prompted, enter the complete PKCS12 certificate (.p12) file path.
When prompted, enter the PKCS12 certificate password.
When prompted, enter the complete client certificate (.pem) file path.
When prompted, enter the client key (.pem).