OpenSearchServer binary installation

This documentation is for OpenSearchServer v1.5 only!

Requirements

You need to have a JAVA 6 (or newer) runtime on your server. Just use the standard package for your operating system.

Download the last ZIP or the TAR.GZ archive:

http://www.open-search-server.com/download

Deflate the content to get the following files:

-rw-r--r--   1 ekeller  staff       7002 12 sep 19:48 CHANGELOG.txt.gz
drwxr-xr-x  14 ekeller  staff        476 12 sep 19:48 LICENSES
-rw-r--r--   1 ekeller  staff       4909 12 sep 19:48 NOTICE.txt
-rw-r--r--   1 ekeller  staff       3305 12 sep 19:48 README.md
drwxr-xr-x   2 ekeller  staff         68 12 sep 19:48 data
-rw-r--r--   1 ekeller  staff  113382592 12 sep 19:48 opensearchserver.jar
-rwxr-xr-x   1 ekeller  staff        488 12 sep 19:48 start.bat
-rwxr-xr-x   1 ekeller  staff        478 12 sep 19:48 start.sh

Your indexes will be stored in the data directory.

Edit the parameters

Optionally, can you change the parameters in the start.sh/start.bat script:

#!/bin/sh

# Move to the directory containing this script
cd `dirname "$0"`

# The directory containing the indexes (must be exported)
OPENSEARCHSERVER_DATA=data
export OPENSEARCHSERVER_DATA

# The TCP port used by the server
SERVER_PORT=9090

# Any JAVA option. Often used to allocate more memory. Uncomment this line to allocate 1GB.
#JAVA_OPTS="-Xms1G -Xmx1G"

# Starting the server
java $JAVA_OPTS -jar opensearchserver.jar -extractDirectory server -httpPort ${SERVER_PORT}

Start the server

cd opensearchserver
./start.sh

You're done!

You can either start by using the WEB user interface http://localhost:9090 or use the API described on this wiki.

Where to go next ?

• Download binaries: http://www.open-search-server.com/download
• The documentation of the RESTFul API: https://github.com/jaeksoft/opensearchserver/wiki
• The user guide: http://www.open-search-server.com/documentation
• Issues (bugs, enhancements): https://github.com/jaeksoft/opensearchserver/issues