ElasticSearch by jonathan-dart

An ElasticSearch module for ProcessWire

ElasticSearch for ProcessWire 0.4.4

About ElasticSearch for ProcessWire


The ElasticSearch module for ProcessWire CMS/CMF will add your page content to an ElasticSearch index per site, and give you a convenient way to search it.

Installation


  • Make sure the PHP cURL library is installed. (apt-get install php5-curl)
  • Install ElasticSearch.
  • Install this module, the usual methods apply.
  • In the module settings configure your ElasticSearch IP and port, and click save.
  • In the module settings click "Index All Pages".

Usage


Synchonizing Page Data with ElasticSearch

When pages are saved, deleted, trashed, and restored ElasticSearch will be notified accordingly, so after you've clicked "Index All Pages" you shouldn't need to think about it again.

What gets searched?


Most content from a page should be seachable: text fields, translated fields, repeaters and filenames.

Searching

This module has a function search() that returns a PageArray.

$search_results = $modules->get('ElasticSearch')->search('foo bar'); 

Pagination

The MarkupPagerNav module should work out of the box.

$search_results = $modules->get('ElasticSearch')->search('foo bar', $results_per_page); 

echo "Total results: " . $search_results->getTotal();

echo $search_results->renderPagination();

Minimum Scores

The search function also takes a 3rd parameter to configure the minimum score required for a page to match.

$search_results = $modules->get('ElasticSearch')->search('foo bar', $results_per_page, 0.05);

Custom Queries

By default this module uses a fuzzy_like_this query to match pages. To change that use an array for the 1st parameter when calling search.

$search_results = $modules->get('ElasticSearch')->search(array(
    'query' => array(
        'match' => array(
            '_all' => 'foo bar',
        ),
    ),
));

ElasticSearch


Configuration

This plugin will create an index based on the http host, so if you have many sites one one server they can all safely use the same ElasticSearch server, no special configuration is required to support multiple sites.

Configuring ElasticSearch can be very simple, if running ElasticSearch on a single server you really only need the below configuration in /etc/elasticsearch/elasticsearch.yml:

index.number_of_shards: 1
index.number_of_replicas: 0
discovery.zen.ping.multicast.enabled: false
discovery.zen.ping.unicast.hosts: []

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Latest news

  • ProcessWire Weekly #526
    In the 526th issue of ProcessWire Weekly we'll cover the latest news from the ProcessWire community: newly open sourced Functional Fields module, new site profile to accompany RockFrontend, and more. Read on!
    Weekly.pw / 8 June 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani