Manual Configuration



Sample Sphinx config file for phpBB sphinx search backend is available here. It has many options which include database details as well as the directory details for sphinx data and config folders.

6.1.3.1. Database Details

Database details on which sphinx daemon and the board are running.

  • type - database type , default mysql.

  • sql_host - hostname, default localhost

  • sql_user

  • sql_pass

  • sql_port - database port, default 3306 for mysql

  • db_name

6.1.3.2. Searchd Details

  • listen - IP address : Sphinx Daemon port, default 127.0.0.1:3312

  • read_timeout - Network client request read timeout in seconds, default 5

  • max_children - Maximum amount of children to fork (concurrent searches to run in parallel), default 30

  • max_matches - the number of search hits to display per result page, default 20000

6.1.3.3. Wildcard searching

By default, wildcard searching is DISABLED and use of * operator will not work. To enable wildcard searching, consider configuring the following parameters:

  • ignore_chars - characters (in Unicode format) ignored and truncated in search index. default none. ignore_chars = U+00AD, U+002D will truncate hyphenated words into single word eg "re-establish" will be indexed as "reestablish". Ignored characters cannot be listed in charset_table.

  • min_prefix_len - minimum prefix length to index. Value greater than 0 will enable partial word match using wordstart* wildcard, default 0 (wildcards disabled). Suggested value 3 (tes* will find test, tested, testing etc)

  • min_infix_len - minimum infix length to index. Value greater than 0 will enable partial word match using 'start*', '*end', and '*middle*' wildcards, default 0 (wildcards disabled). Suggested value 3 (*est* will find test, tested, testing, estimated, shortest etc).

Note

Only use one of either min_prefix_len or min_infix_len, not both. The unused parameter should be set as 0. Enabling wildcard indexing will increase search index size.

6.1.3.4. Stopwords

Sphinx config file provides an option for specifying a file containing search stop words. Stop words are those common words like 'a' and 'the' that appear commonly in text and should really be ignored from searching. A somewhat complete list of English stop words can be found here. These words can be copied into a text file and added to sphinx.conf under index_phpbb section as

stopwords = path/to/stopwords.txt

Content © 2014 phpBB Group
Licensed under the CC Attribution-NonCommercial-ShareAlike 3.0 license