Configuring Squore Service

Windows

During the installation of Squore Server on Windows, the installer provides the option to register a service to control Squore’s startup and shutdown. This section covers the functionality of the prunmgr utility that allows you to further configure some aspects of the Squore Windows service.

After installing Squore Server as a Windows service, you can use the service manager to change some of the settings.

The Windows service uses Apache Commons Daemon. Consult https://commons.apache.org/proper/commons-daemon/index.html for more information about the framework and the available installation options.

Start the utility by typing the following in a command window as administrator:

<SQUORE_HOME>\bin\prunmgr.exe //ES/squore

squore is the service name you chose during the installation.

The service manager opens in a new window and allows you to change the following settings:

General Settings

From the General tab, you can adjust the Service display name, description and startup type (Automatic to start at boot, Manual to start interactively, Disabled to stop using the service). You can also see and change the current state of the service.

Figure 1. The General Tab

Log On

From the Log On tab, you can control which Windows account runs the service. Note that any change takes affect after the service is restarted.

Figure 2. The Log On Tab

The service is set to run under the local system account by default. Depending on your security requirements you may need to manually set the account to a real Windows user to run the services. For more information, consult the Microsoft Windows documentation at https://technet.microsoft.com/en-us/library/cc755249.aspx.

Logging

On the Logging tab, you can define paths to log files where the startup and shutdown activities of the service will be saved.

Figure 3. The Logging Tab

The default location for the log file is %SystemRoot%\System32\LogFiles\Apache and generally does not need to be changed, unless you are noticing issues starting and stopping the service.

Java

The Java tab is useful if you need to change the path to your JRE. You can use jvm.dll from the system’s %PATH%, or you can point to a specific %JAVA_HOME%\bin\server\jvm.dll if needed.

Figure 4. The Java Tab

The settings on this tab have no effect over the Java settings for Squore Server. If you want to change the path to the Java installation or the amount of memory used by Squore, refer to Changing Java installation path and Changing the Java Heap size instead.

Startup and Shutdown

There are no useful settings to be modified on these tabs.

Linux

This section describes how you can create a service to start and stop Squore using the Systemd library for system and service management on Linux.

The example below assumes that:

Your Squore installation is located in /opt/squore/squore-server.
You have created a user called squore to run the service (optional).

To create the service, do the following:

Create a Squore service description file in /etc/systemd/system/squore.service.

[Unit]
Description=Squore Server Service
After=network.target

[Service]
Type=forking
User=squore
ExecStart=/opt/squore/squore-server/bin/sqctl start
ExecStop=/opt/squore/squore-server/bin/sqctl stop

[Install]
WantedBy=multi-user.target

Enable the service, so that it is launched at boot (optional).
```
systemctl enable squore.service
```

You can start and stop Squore service on your system by running the following commands:

sudo systemctl start squore.service
sudo systemctl stop squore.service