Installing Manticore packages on Debian and Ubuntu¶
- 8.0 (jessie)
- 9.0 (stretch)
- 10.0 (buster)
- 14.04 LTS (trusty)
- 16.04 LTS (xenial)
- 18.04 LTS (bionic)
You can install Manticore with command:
$ wget https://github.com/manticoresoftware/manticoresearch/releases/download/3.3.0/manticore_3.3.0-200204-01fc8ad-release.jessie_amd64-bin.deb $ sudo dpkg -i manticore_3.3.0-200204-01fc8ad-release.jessie_amd64-bin.deb
Manticore package depends on zlib and ssl libraries, nothing else is strictly required. However if you plan to use ‘indexer’ tool to create indexes from different sources, you’ll need to install appropriate client libraries. To know what exactly libraries, run indexer tool from Manticore and look at the top of it’s output:
$ indexer Manticore 3.3.0 01fc8ad@200204 release Copyright (c) 2001-2016, Andrew Aksyonoff Copyright (c) 2008-2016, Sphinx Technologies Inc (http://sphinxsearch.com) Copyright (c) 2017-2020, Manticore Software LTD (http://manticoresearch.com) Built by gcc/clang v 6.3.0, Built on Linux runner-72989761-project-3858465-concurrent-0 4.19.78-coreos #1 SMP Mon Oct 14 22:56:39 -00 2019 x86_64 GNU/Linux Configured by CMake with these definitions: -DCMAKE_BUILD_TYPE=RelWithDebInfo -DDISTR_BUILD=stretch -DUSE_SSL=ON -DDL_UNIXODBC=1 -DUNIXODBC_LIB=libodbc.so.2 -DDL_EXPAT=1 -DEXPAT_LIB=libexpat.so.1 -DUSE_LIBICONV=1 -DDL_MYSQL=1 -DMYSQL_LIB=libmariadbclient.so.18 -DDL_PGSQL=1 -DPGSQL_LIB=libpq.so.5 -DLOCALDATADIR=/var/data -DFULL_SHARE_DIR=/usr/share/manticore -DUSE_ICU=1 -DUSE_BISON=ON -DUSE_FLEX=ON -DUSE_SYSLOG=1 -DWITH_EXPAT=1 -DWITH_ICONV=ON -DWITH_MYSQL=1 -DWITH_ODBC=ON -DWITH_PGSQL=1 -DWITH_RE2=1 -DWITH_STEMMER=1 -DWITH_ZLIB=ON -DGALERA_SOVERSION=31 -DSYSCONFDIR=/etc/manticoresearch
Here you can see mentions of libodbc.so.2, libexpat.so.1, libmariadbclient.so.18, and libpq.so.5.
Below is the reference table with list of all client libraries for different debian/ubuntu distributions:
To find the packages which provide the libraries you can use, for example
$ apt-file find libmysqlclient.so.20 libmysqlclient20: /usr/lib/x86_64-linux-gnu/libmysqlclient.so.20 libmysqlclient20: /usr/lib/x86_64-linux-gnu/libmysqlclient.so.20.2.0 libmysqlclient20: /usr/lib/x86_64-linux-gnu/libmysqlclient.so.20.3.6
Note, that you need only libs for types of sources you’re going to use. So if you plan to make indexes only
from mysql source, then install only lib for mysql client (in case above -
Finally install necessary packages:
$ sudo apt-get install libmysqlclient20 libodbc1 libpq5 libexpat1
If you aren’t going to use
indexer tool at all, you don’t need find and install any libraries.
Manticore can optionally use the ICU library for chinese morphology processing. The appropriate ICU library used at compiling must be installed for using the ICU processor. Below is the reference table with the ICU library for different debian/ubuntu distributions:
For example on Debian Stretch
libicu57 needs to be additionally installed for ICU support:
$ sudo apt-get install libicu57
After preparing configuration file (see Quick tour), you can start searchd daemon:
$ systemctl start manticore
Installing Manticore packages on RedHat and CentOS¶
- CentOS 6 and RHEL 6
- CentOS 7 and RHEL 7
- CentOS 8 and RHEL 8
Manticore package depends on zlib and ssl libraries, nothing else is strictly required. However if you plan to use ‘indexer’ tool to create indexes from different sources, you’ll need to install appropriate client libraries. Use yum to download and install these dependencies:
$ yum install mysql-libs postgresql-libs expat unixODBC
Note, that you need only libs for types of sources you’re going to use. So if you plan to make indexes only from mysql source, then installing ‘mysql-libs’ will be enough. If you don’t going to use ‘indexer’ tool at all, you don’t need to install these packages.
For ICU support, additional
libicu package needs to be installed.
$ yum install libicu
Installing Manticore Search from Manticore yum repository¶
Install Manticore yum repository by running as root user or with sudo the following command:
$ yum install http://repo.manticoresearch.com/manticore-repo.noarch.rpm
Install Manticore Search by running:
$ yum install manticore
Install Manticore Search using downloaded rpm packages¶
Download RedHat RPM from Manticore website and install it:
$ wget https://github.com/manticoresoftware/manticoresearch/releases/download/3.3.0/manticore-3.3.0_200204.01fc8ad-1.el7.centos.x86_64.rpm $ rpm -Uhv manticore-3.3.0_200204.01fc8ad-1.el7.centos.x86_64.rpm
Installing Manticore on Windows¶
To install on Windows, you need to download the zip package and unpack it first in a folder.
In the following example we’ll consider folder
C:\Manticore where we unpack the zip content.
cd C:\Manticore unzip manticore-3.3.0-200204-01fc8ad1-release-x64-bin.zip
The zip comes with 2 sample configurations:
manticore-min.conf.in. The latter is a stripped-down of comments version of the first.
The configuration contains a
@CONFIGDIR@ string which needs to be replaced. The
@CONFIGDIR@ is the root directory of
log folders (first is used as location for indexes, second for logs).
The zip package comes with these folders, so they will be available at the location where you unzipped the package. If you want to use a different location, the two folders must be created there.
searchd system as a Windows service:
C:\Manticore\bin> C:\Manticore\bin\searchd --install --config C:\Manticore\manticore.conf.in --servicename Manticore
Make sure to use the full path of the configuration file, otherwise searchd.exe will not be able to know the location of it when it’s started as service.
After installation, the service can be started from the Services snap-in of the Microsoft Management Console.
Once started you can access Manticore using the mysql cli:
C:\path\to\mysql> mysql -P9306 -h127.0.0.1
(note that in most example, we use
-h0, on Windows you need to use
127.0.0.1 for the local host.)
Installing Manticore on MacOS¶
On MacOS Manticore can be installed in 2 easy way:
- Use the official tar containing binary executables. Download it from the website and unpack it to a folder:
$ mkdir manticore $ tar -zxvf manticore-3.3.0-200204-01fc8ad1-release-osx10.14.4-x86_64-bin.tar.gz -C manticore $ cd manticore $ bin/searchd -c manticore.conf
The manticore.conf is located in the root folder.
- Use HomeBrew package manager
$ brew install manticoresearch
Start Manticore as a brew service:
$ brew services start manticoresearch
Upgrading from Sphinx Search¶
Manticore Search 2.x maintains compatibility with Sphinx Search 2.x and can load existing indexes created with Sphinx Search. In most cases, upgrading is just a matter of replacing the binaries.
Manticore Search 3.x breaks compatibility with both Sphinx Search 2.x and Manticore Search 2.x indexes. In this case, indexes must be either remade or converted with the provided index converter tool. For more information check Migrating from Manticore or Sphinx Search 2.x.
In case of Linux distributions, Manticore Search switched the configuration location from
Service name has changed from
manticore and will run under
manticore user ( Spinx was using
sphinxsearch). It also uses a different folder for the PID file.
Default used folders are
Existing file paths can still be used, but permissions should be updated for data,log, run folders.
If you use other folders (for data, wordforms files etc.) the ownership must be also switched to
pid_file location should be changed to match the manticore.service to
If you want to use the Manticore folder instead, the index files needs to be moved to the new data folder (
/var/lib/manticore) and permissions to be changed to
Running Manticore Search in a Docker Container¶
Docker images of Manticore Search are hosted publicly on Docker Hub at https://hub.docker.com/r/manticoresearch/manticore/.
For more information about using Docker, see the Docker Docs.
The searchd daemon runs in nodetach mode inside the container under manticore user. Default configuration includes a simple Real-Time index and listens on the default ports (9306 for SphinxQL, 9312 for SphinxAPI, 9308 for HTTP and 9312-9325 for replication).
The image uses currently the Manticore binaries from the Debian Stretch package.
Starting a Manticore Search instance in a container¶
To start a container running the latest release of Manticore Search run:
docker run --name manticore -p 9306:9306 -d manticoresearch/manticore
Operations with utility tools over running daemon can be made with docker exec command.
Please note that any
indexer command must run under manticore user, otherwise
searchd won’t be able to rotate the files:
docker exec -it manticore gosu manticore indexer --all --rotate
To stop the Manticore Search container you can simply do:
docker stop manticore
or (managed stop with no hard-killing):
docker exec -it manticore gosu manticore searchd --stopwait
Please note that any indexed data or configuration change made is lost if the container is stopped. For persistence, you need to mount the configuration and data folders.
The configuration folder inside the image is the usual /etc/manticoresearch. Index files are located at /var/lib/manticore/data and logs at /var/log/manticore. For persistence, mount these points to your local folders.
docker run --name manticore -v /path/to/config/:/etc/manticoresearch/ -v /path/to/data/:/var/lib/manticore/data -v /path/to/logs/:/var/log/manticore -p 9306:9306 -d manticoresearch/manticore
Compiling Manticore from source¶
a working compiler
- on Linux - GNU gcc (4.7.2 and above) or clang can be used
- on Windows - Microsoft Visual Studio 2015 and above (community edition is enough)
- on Mac OS - XCode
cmake - used on all plaftorms (version 3.13 or above)
Required libraries/packages on Linux¶
- Development version of ssl lib. Usually comes in package named like libssl-dev or openssl-devel.
- Development version of boost. On debian packages libboost-system-dev and libboost-program-options-dev are enough; on redhat it is boost-devel.
- git, flex, bison - needed if the sources are from cloned repository and not the source tarball
- development version of MySQL client for MySQL source driver
- development version of unixODBC for the unixODBC source driver
- development version of libPQ for the PostgreSQL source driver
- development version of libexpat for the XMLpipe source driver
- RE2 (bundled in the source tarball) for regexp_filter feature
- development version of libicudata for ICU chinese morphology processor
- lib stemmer (bundled in the source tarball ) for additional language stemmers
General building options¶
For compiling latest version of Manticore, recommended is checkout the latest code from the github repositiory. Alternative, for compiling a certain version, you can either checked that version from github or use it’s respective source tarball. In last case avoid to use automatic tarballs from github (named there as ‘Source code’), but use provided files as manticore-3.3.0-200204-01fc8ad-release.tar.gz. When building from git clone you need packages git, flex, bison. When building from tarball they are not necessary. This requirement may be essential to build on Windows.
$ git clone https://github.com/manticoresoftware/manticore.git
$ wget https://github.com/manticoresoftware/manticoresearch/releases/download/3.3.0/manticore-3.3.0-200204-01fc8ad-release.tar.gz $ tar zcvf manticore-3.3.0-200204-01fc8ad-release.tar.gz
Next step is to configure the building with cmake. Available list of configuration options:
CMAKE_BUILD_TYPE- can be Debug , Release , MinSizeRel and RelWithDebInfo (default).
SPLIT_SYMBOLS(bool) - specify whenever to create separate files with debugging symbols. In the default build type,RelWithDebInfo, the binaries include the debug symbols. With this option specified, the binaries will be stripped of the debug symbols , which will be put in separate files
USE_FLEX(bool) - enabled by default, specifies whenever to enable bison and flex tools
LIBS_BUNDLE- filepath to a folder with different libraries. This is mostly relevant for Windows building
WITH_STEMMER(bool) - specifies if the build should include the libstemmer library. The library is searched in several places, starting with
- libstemmer_c folder in the source directory
- common system path. Please note that in this case, the linking is dynamic and libstemmer should be available system-wide on the installed systems
- libstemmer_c.tgz in
- download from snowball project website (https://snowballstem.org/dist/libstemmer_c.tgz). This is done by cmake and no additional tool is required.
- NOTE: if you have libstemmer in the system, but still want to use static version, say, to build a binary for a system without such lib, provide
WITH_RE2(bool) - specifies if the build should include the RE2 library. The library can be taken from the following locations:
- in the folder specified by
- in libre2 folder of the Manticore sources
- system wide search, while first looking for headers specified by
WITH_RE2_INCLUDESfolder and the lib files in
- check presence of master.zip in the
- Download from https://github.com/manticoresoftware/re2/archive/master.zip
- NOTE: if you have RE2 in the system, but still want to use static version, say, to build a binary for a system without such lib, provide
- in the folder specified by
WITH_EXPAT(bool) enabled compiling with libexpat, used XMLpipe source driver
WITH_MYSQL(bool) enabled compiling with MySQL client library, used by MySQL source driver. Additional parameters
WITH_MYSQL_INCLUDEScan be used for custom MySQL files
WITH_ODBC(bool) enabled compiling with ODBC client library, used by ODBC source driver
WITH_PGSQL(bool) enabled compiling with PostgreSQL client library, used by PostgreSQL source driver
WITH_ICU(bool) enabled compiling with ICU library support, used by morphology processor
DISTR_BUILD- in case the target is packaging, it specifies the target operating system. Supported values are: rhel6, rhel7, rhel8, wheezy, jessie, stretch, buster, trusty, xenial, bionic, macos, default.
Compiling on Linux systems¶
To install all dependencies on Debian/Ubuntu:
$ apt-get install build-essential cmake unixodbc-dev libpq-dev libexpat-dev libmysqlclient-dev libicu-dev libssl-dev libboost-system-dev libboost-program-options-dev git flex bison
Note: on Debian 9 (stretch) package
libmysqlclient-dev is absent. Use
default-libmysqlclient-dev there instead.
To install all dependencies on CentOS/RHEL:
$ yum install gcc gcc-c++ make cmake mysql-devel expat-devel postgresql-devel unixODBC-devel libicu-devel openssl-devel boost-devel rpm-build systemd-units git flex bison
(git, flex, bison doesn’t necessary if you build from tarball)
RHEL/CentOS 6 ship with a old version of the gcc compiler, which doesn’t support -std=c++11 flag, for compiling use devtools repository:
$ wget http://people.centos.org/tru/devtools-2/devtools-2.repo -O /etc/yum.repos.d/devtools-2.repo $ yum upgrade -y $ yum install -y devtoolset-2-gcc devtoolset-2-binutils devtoolset-2-gcc-c++ $ export PATH=/opt/rh/devtoolset-2/root/usr/bin:$PATH
Manticore uses cmake for building. We recommend to use a folder outside the sources to keep them clean.
$ mkdir build $ cd build $ cmake3 -D WITH_MYSQL=1 -DWITH_RE2=1 ../manticore
or if we use sources from tarball:
$ cmake3 -D WITH_MYSQL=1 -DWITH_RE2=1 ../manticore-3.3.0-200204-01fc8ad-release
To simply compile:
$ make -j4
This will create the binary files, however we want to either install Manticore or more convenient to create a package. To install just do
$ make -j4 install
For packaging use
$ make -j4 package
By default, if no operating system was targeted,
package will create only a zip with the binaries.
If, for example, we want to create a deb package for Debian Jessie, we need to specify to cmake the
$ cmake3 -DDISTR_BUILD=jessie ../manticore $ make -j4 package
This will create 2 deb packages, a manticore-x.x.x-bin.deb and a manticore-x.x.x-dbg.deb which contains the version with debug symbols.
Another possible target is
tarball , which create a tar.gz file from the sources.
Compiling on Windows¶
For building on Windows you need:
- Visual Studio
- Cmake for Windows
- Expat, MySQL and PostgreSQL in bundle directory.
If you build from git clone, you also need to provide git, flex, bison tools. They may be fond in cygwin framework. When building from tarball these tools are not necessary.
For a simple building on x64:
C:\build>"%PROGRAMW6432%\CMake\bin\cmake.exe" -G "Visual Studio 14 Win64" -DLIBS_BUNDLE="C:\bundle" "C:\manticore" C:\build>"%PROGRAMW6432%\CMake\bin\cmake.exe" -DWITH_PGSQL=1 -DWITH_RE2=1 -DWITH_STEMMER=1 . C:\build>"%PROGRAMW6432%\CMake\bin\cmake.exe" --build . --target package --config RelWithDebInfo
Compiling on FreeBSD¶
Support for FreeBSD is limited and successful compiling is not guaranteed. We recommend checking the issue tracker for unresolved issues on this platform before trying to compile latest versions.
FreeBSD uses clang instead of gcc as system compiler and it’s installed by default.
First install required packages:
$ pkg install cmake bison flex
To compile a version without optional dependencies:
$ cmake -DUSE_GALERA=0 -DWITH_MYSQL=0 -DDISABLE_TESTING=1 ../manticoresearch/ $ make
With the exception of Galera, the rest of optional dependencies can be installed:
$ pkg install mariadb103-client postgresql-libpqxx unixODBC icu expat
(you can replace
mariadb103-client with MySQL client package of your choice)
Building with all optional features and installation system-wide:
$ cmake -DUSE_GALERA=0 -DWITH_PGSQL=1 -DDISABLE_TESTING=1 -DCMAKE_INSTALL_PREFIX=/ -DCMAKE_INSTALL_LOCALSTATEDIR=/var ../manticoresearch/ $ make $ make install
If you didn’t change path for sources and build, just move to you build folder and run:
cmake3 . make clean make
If by any reason it doesn’t work, you can delete file
CMakeCache.txt located in build folder.
After this step you have to run cmake again, pointing to source folder and configuring the options.
If it also doesn’t help, just wipe out your build folder and begin clean compiling from sources
Quick Manticore usage tour¶
We are going to use SphinxQL protocol as it’s the current recommended way and it’s also easy to play with. First we connect to Manticore with the normal MySQL client:
$ mysql -h0 -P9306
The default configuration comes with a sample Real-Time. A first step to see it in action is to add several documents to it, then you can start perform searches:
mysql> INSERT INTO rt VALUES (1, 'this is', 'a sample text', 11); Query OK, 1 row affected (0.00 sec) mysql> INSERT INTO rt VALUES (2, 'some more', 'text here', 22); Query OK, 1 row affected (0.00 sec) mysql> INSERT INTO rt VALUES (3, 'more about this text', 'can be found in this text', 22); Query OK, 1 row affected (0.00 sec)
mysql> SELECT *,weight() FROM rt WHERE MATCH('text') ORDER BY WEIGHT() DESC; +------+------+----------+ | id | gid | weight() | +------+------+----------+ | 3 | 22 | 2252 | | 1 | 11 | 1319 | | 2 | 22 | 1319 | +------+------+----------+ 3 rows in set (0.00 sec)
In the sample configuration there is also a plain index with MySQL source, which needs to be indexed first in order to start using it. First, we populate the sample table in MySQL:
mysql> create database test; $ mysql -u test < /usr/share/doc/manticore/example-conf/example.sql
The sample config uses a
test with no password for connecting to MySQL. Adjust the credentials, then index:
$ sudo -u manticore indexer -c /etc/sphinxsearch/manticore.conf test1 --rotate Manticore 3.3.0 01fc8ad@200204 release Copyright (c) 2001-2016, Andrew Aksyonoff Copyright (c) 2008-2016, Sphinx Technologies Inc (http://sphinxsearch.com) Copyright (c) 2017-2020, Manticore Software LTD (http://manticoresearch.com) using config file '/etc/sphinxsearch/manticore.conf'... indexing index 'test1'... collected 4 docs, 0.0 MB sorted 0.0 Mhits, 100.0% done total 4 docs, 193 bytes total 0.002 sec, 81503 bytes/sec, 1689.18 docs/sec total 4 reads, 0.000 sec, 8.1 kb/call avg, 0.0 msec/call avg total 12 writes, 0.000 sec, 0.1 kb/call avg, 0.0 msec/call avg rotating indices: successfully sent SIGHUP to searchd (pid=2947).
Now let’s run several queries:
mysql> SELECT *, WEIGHT() FROM test1 WHERE MATCH('"document one"/1');SHOW META; +------+----------+------------+----------+ | id | group_id | date_added | weight() | +------+----------+------------+----------+ | 1 | 1 | 1502280778 | 2663 | | 2 | 1 | 1502280778 | 1528 | +------+----------+------------+----------+ 2 rows in set (0.00 sec) +---------------+----------+ | Variable_name | Value | +---------------+----------+ | total | 2 | | total_found | 2 | | time | 0.000 | | keyword | document | | docs | 2 | | hits | 2 | | keyword | one | | docs | 1 | | hits | 2 | +---------------+----------+ 9 rows in set (0.00 sec)
mysql> SET profiling=1;SELECT * FROM test1 WHERE id IN (1,2,4);SHOW PROFILE; Query OK, 0 rows affected (0.00 sec) +------+----------+------------+ | id | group_id | date_added | +------+----------+------------+ | 1 | 1 | 1502280778 | | 2 | 1 | 1502280778 | | 4 | 2 | 1502280778 | +------+----------+------------+ 3 rows in set (0.00 sec) +--------------+----------+----------+---------+ | Status | Duration | Switches | Percent | +--------------+----------+----------+---------+ | unknown | 0.000059 | 4 | 44.70 | | net_read | 0.000001 | 1 | 0.76 | | local_search | 0.000042 | 1 | 31.82 | | sql_parse | 0.000012 | 1 | 9.09 | | fullscan | 0.000001 | 1 | 0.76 | | finalize | 0.000007 | 1 | 5.30 | | aggregate | 0.000006 | 2 | 4.55 | | net_write | 0.000004 | 1 | 3.03 | | eval_post | 0.000000 | 1 | 0.00 | | total | 0.000132 | 13 | 0 | +--------------+----------+----------+---------+ 10 rows in set (0.00 sec)
mysql> SELECT id, id%3 idd FROM test1 WHERE MATCH('this is | nothing') GROUP BY idd;SHOW PROFILE; +------+------+ | id | idd | +------+------+ | 1 | 1 | | 2 | 2 | | 3 | 0 | +------+------+ 3 rows in set (0.00 sec) +--------+----------+----------+---------+ | Status | Duration | Switches | Percent | +--------+----------+----------+---------+ | total | 0.000000 | 0 | 0 | +--------+----------+----------+---------+ 1 row in set (0.00 sec)
mysql> SELECT id FROM test1 WHERE MATCH('is this a good plan?');SHOW PLAN\G Empty set (0.00 sec) *************************** 1. row *************************** Variable: transformed_tree Value: AND( AND(KEYWORD(is, querypos=1)), AND(KEYWORD(this, querypos=2)), AND(KEYWORD(a, querypos=3)), AND(KEYWORD(good, querypos=4)), AND(KEYWORD(plan, querypos=5))) 1 row in set (0.00 sec)
mysql> SELECT COUNT(*) c, id%3 idd FROM test1 GROUP BY idd HAVING COUNT(*)>1; +------+------+ | c | idd | +------+------+ | 2 | 1 | +------+------+ 1 row in set (0.00 sec)
mysql> SELECT COUNT(*) FROM test1; +----------+ | count(*) | +----------+ | 4 | +----------+ 1 row in set (0.00 sec)
mysql> CALL KEYWORDS ('one two three', 'test1', 1); +------+-----------+------------+------+------+ | qpos | tokenized | normalized | docs | hits | +------+-----------+------------+------+------+ | 1 | one | one | 1 | 2 | | 2 | two | two | 1 | 2 | | 3 | three | three | 0 | 0 | +------+-----------+------------+------+------+ 3 rows in set (0.00 sec)