Installing BrightServer as a Windows Service

Contents Hide

  

BrightServer(TM) is designed to be set up and run as a Windows service. This allows BrightServer to run in the background for the machine, and be configured to automatically start/stop via configuring its service properties.

By default, if you have installed BrightServer using a setup.exe, then BrightServer will be installed as a Windows service - 'BrightServer', inactive and set to start up manually. This will not be present for installation via archive or service-free installations, whereby the steps detailed under Configuring Multiple BrightServer Services may be performed.

Configuring Multiple BrightServer Services

If there is currently a different BrightServer instance installed and/or running on the machine the new instance is to be installed on, running the installation script will fail, as the service name has already been defined. To install the service under a different name, open the "wrapper.conf" file in the 'service' directory, and locate the following lines (90-94):

# Name of the service

wrapper.ntservice.name=BrightServer

 

# Display name of the service

wrapper.ntservice.displayname=BrightServer

Change the "BrightServer" values to a different, unique service name (for example, "BrightServer Test") and then proceed with the installation. For more information, please refer to the Installing Multiple BrightServer Instances chapter of this document.

Installing and Uninstalling the Service

Once the configuration file is assigned correctly, simply run

InstallBrightServerService.bat

To remove BrightServer as a Windows service, run

UninstallBrightServerService.bat

Please ensure that the system user running this batch file has adequate permissions to create the service within the operating system.

Automatically Starting the Service

The BrightServer service may be set to start up automatically with Windows, using the Windows' Services panel. This may be performed by the following steps:

  1. Under Windows Services window, locate the BrightServer service.

  2. Right Click on the service, and select 'Properties', which will open the Properties dialog.

  3. Change the startup type to 'Automatic', then tap OK.

With this set, subsequent Windows startups will start BrightServer automatically. The service may still be start and stopped as described above.

If BrightServer is configured to access local databases for its System configuration, the 'Automatic (Delayed Startup)' startup type is recommended, such that local resources are may be initialised prior to BrightServer's startup.