login / register
voyager
Home » Administrator Guide » Running as Windows Service

Running as Windows Service

Installing Voyager as a Windows Service

With a WORKGROUP or ENTERPRISE license, you can install Voyager as a windows service.

To configure Voyager to run as a windows service simply execute the following command with the appropriate command-line option:

VoyagerService.exe \[OPTION\]

Options:
Parameter Description
/install Installs service in start-on-demand mode. The service must be manually started by the user in the Windows service manager. Once installed the service can be configured in the windows service manager. (see note below on how to specify a service name)
/install-auto Installs the service in auto-start mode. In auto start mode, your service is always started when Windows is booted.
/uninstall Used for uninstalling an existing service
/start Start a service that has already been installed
/stop Stop a service that has already been installed
/status Status shows if the service is already running. The exit code of the status command is 0 when the service is running, 3 when it is not running and 1 when the state cannot be determined (for example when it is not installed on Windows).


The VoyagerService executable is located in the software installation directory at: .\app\VoyagerService.exe

Notes on /install parameter:

As a second parameter after the /install parameter, you can optionally pass a service name. In that way you can:

  • Install a service with a different service name than the default name.
  • Use the same service executable to start multiple services with different names. To distinguish several running service instances at runtime, you can query the system property exe4j.launchName for the service name. Note that you also have to pass the same service name as the second parameter if you use the /uninstall, /start and /stop parameters.


In some situations, you might want to install a Windows service as a non-interactive service meaning that the service will not have any possibility to access the GUI subsystem. In order to do that, add non-interactive after the /install parameter. A custom service name can still be specified after the non-interactive parameter.

Installing windows services requires administrative permissions

When installing the Voyager service it is important that you are either logged into the computer with an administrative account, or with Windows Vista and Windows 7 you can elevate your permission to run specific processes as an administrator.

Therefore, if you see this type of error it is possible that you do not have the necessary permissions to install the Voyager service:




To resolve the problem be sure to log in with an administrative account or elevate the permissions of your existing account. Elevating the permissions of a process can be done using the context menu on the process executable or via the shortcut illustrated here:




Important note on windows service Logon Account

It is important that the voyager service runs as an account with suitable permission to access data that it should index. Voyager has been designed to require read-only access to data.

A service, like any process, has a security identity that determines the granted rights and privileges for accessing local and network resources. This security identity, or security context, is important in determining how Voyager accesses local and network resources.

When services are installed the default account used for running the service is the windows SYSTEM account. In general this account will not have the necessary permissions to access data to be indexed.

You can view the account that Voyager service uses via the Services dialog:





To change the permissions simply double click on the service name, choose the “log on” tab and the enter the necessary account information:







» Show in Whole Document