This section contains instructions for installing and deploying Rosette Server as a RESTful server on Windows.
Additional Windows requirements
The packages are shipped as tar.gz files. To unpack the files you will need a third-party archiving tool. A recommended tool is:
Unpack the files from a Windows prompt
From a Windows Command Prompt:
-
Set the install location for the Rosette Server main package, referenced here as %ROSAPI%
set ROSAPI=C:\rosette-<version>\server
mkdir %ROSAPI%
-
Using 7-Zip, unpack the Server main package from the current directory into the %ROSAPI% directory
7z x "rosette-enterprise-<version>.tar.gz" -so | 7z x -aoa -si -ttar -o"%ROSAPI%"
Ignore any symbolic link messages from 7-Zip.
-
Set the install location for the component packages, referenced here as %ROSAPI_ROOTS%
set ROSAPI_ROOTS=C:\rosette-<version>\roots
mkdir %ROSAPI_ROOTS%
-
Unpack the component packages from the current directory into %ROSAPI_ROOTS% directory
unpack-roots.bat "path to root tar.gz files" %ROSAPI_ROOTS%
unpack-roots.bat is a Windows-specific batch script that requires 7-Zip
Copy the license file into the subdirectory of your install directory.
copy rosette-license.xml %ROSAPI%\launcher\config\rosapi\
Set the runtime environment variables
-
Set ROSAPI_ROOTS in the user profile.
set ROSAPI_ROOTS=C:\rosette-<version>\roots
-
Set JAVA_HOME in the user profile, if not already set. For example:
set JAVA_HOME=C:\java\jdk-<version>
Tip
Your location of JAVA_HOME may differ based on your installation of Java.
-
If installing the names roots (name similarity, translation, or deduplication endpoints), add the roots to the path.
set PATH=%PATH%;%ROSAPI_ROOTS%\rni-rnt\<rni-rnt root version>\rlp\bin\amd64-w64-msvc120
To run from the Command Prompt:
cd %ROSAPI%\bin
App.bat
Note
If your installation includes the entity extraction component (rex-root), you may see failed to open ... warning messages for data files in languages not installed in your system. These can safely be ignored.
Note
You can check the logs in %ROSAPI%\logs\ for any errors that you may encounter at startup or when running the server.
To stop Rosette:
From the /bin directory
cd %ROSAPI%\bin
launcher stop
or
cd %ROSAPI%\bin
stop-launcher
Install as a Windows service
Before completing these steps, you must have unpacked the files and installed the license file.
-
Check for existing installations.
cd %ROSAPI%\bin
AppCommand.bat status
-
Remove any existing installations.
cd %ROSAPI%\bin
AppCommand.bat remove
-
Install Rosette Server as a Windows service.
cd %ROSAPI%\bin
AppCommand.bat install
-
(Optional) Add the runtime environment variables (JAVA_HOME and ROSAPI_ROOTS) to the %ROSAPI%\conf\wrapper.conf file.
set.JAVA_HOME=C:/Java/jdk-<version>
set.ROSAPI_ROOTS=C:/rosette/roots
Tip
Any required runtime environment variables should be accessible to the "Local System Account" or configured in %ROSAPI%\conf\wrapper.conf.
It is important to understand how the service wrapper evaluates environment variables. You can read more about the details of variable expansion and definition here.