Installing on Windows

When upgrading, if there is a running instance of SpectX Server on the machine, it must be stopped first by executing command bin\spectx.exe stop in case it is running as a service, or by terminating the corresponding process if it is running in console in foreground.

The following steps must be performed for installing SpectX Server on Microsoft Windows.

1. Download SpectX for Windows.
2. Unpack the file spectx-v{version}-win64.zip.
3. Open the command line and navigate to the unpacked directory spectx\.
4. If running the SpectX server for the first time, start it in foreground by executing bin\spectx.exe run, or install and start it as a Windows service by executing bin\sa.exe setup. If the server was installed before and has just been freshly upgraded, start it accordingly to previous configuration, i.e. by executing bin\spectx.exe start for starting it as Windows service, or by executing bin\spectx.exe run to run it in the console in foreground.

Upon its very first run, SpectX will ask several questions to define user access and privileges, network, and cache settings, and password for the default admin user. Press Enter to accept the default settings, or customise as desired.

Service interface (wgui.host)                           [127.0.0.1]:
Service port (wgui.port)                                [8388]:
File access policy (engine.da.protocol.file)            [managed]:
Create local cache (sx.pu_data.cache.enabled)           [false]: true
Cache directory (sx.pu_data.cache.dir)                  [${SPECTX_HOME}\pudata\cache]:
Cache max size (sx.pu_data.cache.max_size), 0=unlimited [0GB]:
New password for user 'admin' (min length 8 symbols)    :
New password for user 'admin' again                     [*********]:

Configuration saved to C:\Users\user\Downloads\spectx\spectx\conf\sx.conf

The SpectX web interface is at http://127.0.0.1:8388/

These questions define:

1. Defines the IP address or hostname of the SpectX server process:

   Default value=127.0.0.1

Note

SpectX may override this setting during the activation process. The Free license allows using SpectX Server Edition only at localhost (127.0.0.1).

2. Defines the port that SpectX is listening on:

   Default value=8388

3. Defines the access mode to local file system for all SpectX users. See Protecting Access to Local Data for details.

Default value=managed

Note

SpectX may override this setting during the activation process. The Free license does not allow access control.

4. Defines whether or not SpectX creates a local data cache. SpectX can create a local data cache of its most frequently accessed data, this function improves subsequent query speeds and reduces network resource consumption.

   Enter true to give SpectX permission to create a cache. If a cache is created Spectx prompts to define the locations and data constraints of the cache. The location of the data cache can also be defined to secondary or external storage which further optimises passing times.

   Default value=false

5. Defines password for user ‘admin’.

Note

SpectX may override this setting during the activation process. The Free license allows only unauthenticated single user mode, therefore the ‘admin’ user and specified password are ignored.

After the initial setup administrators can further customise SpectX to the security requirements of their own organizations and users. For information on all additional settings see securing.

Once the initial setup is complete, then open a web browser and navigate to the localhost (default: http://127.0.0.1:8388/) and log in to SpectX WUI using the default user name admin and the password submitted during setup.

6. Accept EULA:

7. Activate SpectX

Installation Directories

During the very first run, SpectX creates its configuration file conf\sx.conf based on the content of configuration template file conf\sx.conf.win.default and the user input provided to configuration questions. It also creates system properties definition file bin\spectx.exe.vmoptions based on template file bin\sspectx.exe.vmoptions.default. This file is used for SpectX’s java process initialization. Also, it creates directories data\ (resource tree) and pudata\ (query processing related data), logs\ (own logs) and a user database file sxwgui.db. The layout of the spectx\ directory becomes as follows:

.\
└── spectx\
    ├── bin\
    │   ├── spectx.exe                   : SpectX service launcher
    │   ├── spectx.exe.vmoptions         : copied from spectx.exe.vmoptions.default template on first run
    │   └── spectx.exe.vmoptions.default : system properties definitions template
    ├── conf\
    │   ├── sx.conf                      : created from sx.conf.default on first run
    │   └── sx.conf.win.default          : default configuration template
    ├── data\                            : SpectX user data (resource tree)
    ├── jre\                             : Java runtime
    ├── lib\                             : SpectX binaries
    ├── logs\                            : SpectX logs
    ├── pudata\                          : cache, temporary files, etc
    └── sxwgui.db                        : database containing SpectX user role definitions

Note that the files conf\sx.conf and bin\spectx.exe.vmoptions will not be modified or deleted during the updates in the future.