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.
Note
If you are using the Docker version of Match Studio on a Windows machine, see Docker_on_Windows_installation.pdf, which is included in the Docker version zip file.
The following files are included in the RMS shipment:
-
rosette-match-studio-<version>.zip: Docker version of Match Studio
-
rlp-license.xml: License file
-
RMS-installation-guide.pdf: This guide
-
Java 17 installed
-
At least 8 GB of RAM
-
At least 50 GB of hard disk space
-
Docker is installed, running, and configured properly
Note
For more information on how to configure Docker for each OS, see the included README.
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.
-
Extract the contents of rosette-match-studio-<version>.zip.
-
Locate and open the docker-compose.yml file inside the RMS installer.
-
This file has two services commented out. Uncomment the following services: vault-server and vault-client.
Important
Do not uncomment Kibana.
-
Save the changes.
-
Locate and open the application.yml file inside the config-backend folder.
-
Change the rms-vault parameters as follows:
rms-vault:
enabled: true
vault-application: rms
vault-address: http://vault:8200
token: root
-
Save the changes.
-
Locate and open the application.yml file inside the config-ingest folder.
-
Change the rms-vault parameters as follows:
rms-vault:
enabled: true
vault-application: rms
vault-address: http://vault:8200
token: root
-
Save the changes.
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)
SSL is disabled by default. To enable SSL:
-
Add the PKCS12 and client certificates to the match-studio-{project.version}/keystore folder.
-
Update the match-studio-${project.version}/config-backend/application.yml file as follows:
server:
port: 8090
ssl:
key-store-type: <key type>
key-store: /home/jboss/keystore/<key file name>
key-store-password: <password>
enabled: true
-
Update the match-studio-${project.version}/docker-compose.yml file to add the key and certificate for React as follows:
environment:
- SSL_ENABLED=true
- SSL_CLIENT_KEY=/home/jboss/keystore/<key file name>
- SSL_CLIENT_CERT=/home/jboss/keystore/<certificate name>
-
Extract the contents of rosette-match-studio-<version>.zip if you have not done so already.
-
Copy the included license key file rlp-license.xml into the bt_roots/licenses directory.
-
If you are running on a remote machine, modify config-backend/application.yml to replace any mention of localhost with the IP address of the deployment machine.
-
Run docker-compose up.