Installation

If this is your first time installing, configuring, or developing with the Semanteer Search Layer, please take the time to go through this section and learn how to perform a standard installation, go through the initial configuration steps, and get started with a predefined schema, with or without a demo data set.

Sections

Unpacking, initial configuration, running

Learn how to deploy the Semanteer Search Platform bundle, perform required initial configuration steps, and run the platform.

Installing the bundle

Bundle contents

The Semanteer Search Platform comes as a bundle that is made up by the following components:

  • Apache Tomcat application server 9.x

  • Semanteer Search Layer

  • Apache Solr 9.3

  • Semanteer Monitoring and Search Analysis

Initial configuration

The directory <install-dir>/conf/ contains all necessary files to configure startup parameters and search properties. As a first step, you will want to modify the basic execution parameters, such as the ports at which the main components will be running, logging, etc.

semanteer.properties

In semanteer.properties the startup ports for Solr and the Semanteer Search-Layer, the activated spring profile and the memory reserved for Solr must be specified, e.g.:

Example of semanteer.properties
controller.port=8036
searchlayer.port=8030
searchlayer.shutdownport=8032
solr.port=8035
solr.mem=2g
springprofile=dev

search-layer-<profile>.conf

For your activated profile you can add configuration files that typically specify the server port and urls for the solr cores, as well as login information for the admin area of the Semanteer Search-Layer, e.g.

Example of search-layer-<profile>.conf
server.port=8030

# Solr URLs
solr.url=http://localhost:8035/solr/winedemo
solr.monitoring.url=http://localhost:8035/solr/sem_monitoring_core
solr.analytics.url=http://localhost:8035/solr/sem_monitoring_core

Syntax highlighting is enabled by setting the source-highlighter attribute in the document header or passed as an argument.

Start / Stop Semanteer Search

The Semanteer Search and all components can be started and stopped with the <install-dir>/bin/semanteer.sh script.

Status/(Re)Start/Stop all components
bin/semanteer.sh status|start|stop|restart
Status/(Re)Start/Stop the Search-Layer (tomcat)
bin/semanteer.sh tomcat status|start|stop|restart
Status/(Re)Start/Stop/Setup Solr
bin/semanteer.sh solr solr status|start|stop|restart|upload|setup

  • setup: Bootstraps the solr collection(s), which means uploading the config(s) to zookeeper and creating the core(s)

  • upload: Reuploads the config(s) for the solr collection(s)

Status/(Re)Start/Stop the Controller
bin/semanteer.sh controller status|start|stop|restart

First steps after deployment

Once you have your Semanteer Search Platform up and running, you can start with the tailoring of the installation to your needs, starting from predefined index schemata, and making use of sample search configurations and demo content.

Installation with Docker Compose

Alternatively, you can deploy a lightweight version of the bundle with Docker containers:

Load the images

tar -xvzf sem-bundle-docker.tgz
docker load --input images.img
Start/Stop the containers
docker compose up -d
docker compose down

The compose up command creates the following 3 containers:

  • solr The version of the image pulled can be configured in docker-compose.yml (default 9.3.0).

  • searchlayer

  • controller

Environment variables, port bindings and volumes can also be configured in docker-compose.yml. Semanteer and Search Layer configuration files are located in <install-dir-docker>/conf.

Ports used in these configuration files refer to container ports.