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:
Add the 7-zip installation directory to your system path, then follow the instructions to Unpack the Files from a Windows Prompt.
Install the License File when you have completed the installation and are ready to continue.
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
Using 7-Zip, unpack the Server main package from the current directory into the
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
Unpack the component packages from the current directory into
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
ROSAPI_ROOTS in the user profile.
JAVA_HOME in the user profile, if not already set. For example:
or, for Java 9 or later:
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:
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.
You can check the logs in
%ROSAPI%\logs\ for any errors that you may encounter at startup or when running the server.
Install as a Windows Service
Before completing these steps, you must have unpacked the files and installed the license file.
Check for existing installations.
Remove any existing installations.
Install Rosette Server as a Windows service.
(Optional) Add the runtime environment variables (
ROSAPI_ROOTS) to the
Any required runtime environment variables should be accessible to the "Local System Account" or configured in
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.