You are here

Home » API reference » Search API Algolia 7

README.txt in Search API Algolia 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 2.0.x README.txt
CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Known problems
 * Maintainers
 * Dependencies


INTRODUCTION
------------
This module provides integration with the Algolia service
(https://www.algolia.com), through Drupal's Search API. This module is intended
to be used by developers, as it does not currently provide any implementation of
an actual search interface. Only indexing is currently supported. As a result,
enabling that module will not have any visible effect on your application.
Search functionality may be implemented using the Algolia Javascript API.

Currently supported:
 * initial indexing of node entities (see "Know problems")
 * re-indexing on node updates or through forced re-index action

Type of fields which have been successfully tested:
 * entity reference fields (either single or multivalued)
 * standard text fields containing either strings or integers (integer support 
   is important for comparison functions in the search query)


REQUIREMENTS
------------
This module requires the following modules:
 * Libraries API (https://www.drupal.org/project/libraries)
 * Search API (https://www.drupal.org/project/search_api)
 * Entity API (https://www.drupal.org/project/entity)

This module also uses the following library:
 * Algolia search client PHP library 
   https://github.com/algolia/algoliasearch-client-php


INSTALLATION
------------
Please refer to the INSTALL.txt file.


KNOWN PROBLEMS
--------------
 * At the moment, the HTML filter (Index > Filters > Processors) with Tag boosts
   is not supported as it creates separate entries in the items tree. Please 
   make sure that the "Tag boosts" text area is empty.
 * Only node entities are supported for now. User entities have been 
   successfully implemented but more tests need to be completed.
 * Standard multi-valued select fields are not indexed properly as both key and
   value are shown in the resulting indexed data.
 * "Clear all indexed data" button on the index page is not implemented yet, as 
   it collided with normal indexing operations. To clear the index, please 
   proceed from the Algolia dashboard.


MAINTAINERS
-----------
Current maintainer: Matthieu Bergel (mbrgl) - https://www.drupal.org/user/489214

The initial development of this module has been sponsored by TroisCube 
(http://www.troiscube.com).


DEPENDENCIES
------------
This module requires an account on https://www.algolia.com, where you will be
able to generate the required Application ID and API key. A 14-day free trial
period is granted with every new account.

Pricing options can be found on the Algolia website: 
https://www.algolia.com/pricing

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3.  * Introduction

  4.  * Requirements

  5.  * Installation

  6.  * Known problems

  7.  * Maintainers

  8.  * Dependencies

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. This module provides integration with the Algolia service

  14. (https://www.algolia.com), through Drupal's Search API. This module is intended

  15. to be used by developers, as it does not currently provide any implementation of

  16. an actual search interface. Only indexing is currently supported. As a result,

  17. enabling that module will not have any visible effect on your application.

  18. Search functionality may be implemented using the Algolia Javascript API.

  19. 

  20. Currently supported:

  21.  * initial indexing of node entities (see "Know problems")

  22.  * re-indexing on node updates or through forced re-index action

  23. 

  24. Type of fields which have been successfully tested:

  25.  * entity reference fields (either single or multivalued)

  26.  * standard text fields containing either strings or integers (integer support 

  27.    is important for comparison functions in the search query)

  28. 

  29. 

  30. REQUIREMENTS

  31. ------------

  32. This module requires the following modules:

  33.  * Libraries API (https://www.drupal.org/project/libraries)

  34.  * Search API (https://www.drupal.org/project/search_api)

  35.  * Entity API (https://www.drupal.org/project/entity)

  36. 

  37. This module also uses the following library:

  38.  * Algolia search client PHP library 

  39.    https://github.com/algolia/algoliasearch-client-php

  40. 

  41. 

  42. INSTALLATION

  43. ------------

  44. Please refer to the INSTALL.txt file.

  45. 

  46. 

  47. KNOWN PROBLEMS

  48. --------------

  49.  * At the moment, the HTML filter (Index > Filters > Processors) with Tag boosts

  50.    is not supported as it creates separate entries in the items tree. Please 

  51.    make sure that the "Tag boosts" text area is empty.

  52.  * Only node entities are supported for now. User entities have been 

  53.    successfully implemented but more tests need to be completed.

  54.  * Standard multi-valued select fields are not indexed properly as both key and

  55.    value are shown in the resulting indexed data.

  56.  * "Clear all indexed data" button on the index page is not implemented yet, as 

  57.    it collided with normal indexing operations. To clear the index, please 

  58.    proceed from the Algolia dashboard.

  59. 

  60. 

  61. MAINTAINERS

  62. -----------

  63. Current maintainer: Matthieu Bergel (mbrgl) - https://www.drupal.org/user/489214

  64. 

  65. The initial development of this module has been sponsored by TroisCube 

  66. (http://www.troiscube.com).

  67. 

  68. 

  69. DEPENDENCIES

  70. ------------

  71. This module requires an account on https://www.algolia.com, where you will be

  72. able to generate the required Application ID and API key. A 14-day free trial

  73. period is granted with every new account.

  74. 

  75. Pricing options can be found on the Algolia website: 

  76. https://www.algolia.com/pricing