You are here

Home » API reference » Search API Algolia 7

INSTALL.txt in Search API Algolia 7

Same filename and directory in other branches
  1. 8 INSTALL.txt
  2. 2.0.x INSTALL.txt
INSTALLING MODULES AND LIBRARIES
--------------------------------
 * Download the module and all of its dependencies. Move them to the contributed
   modules location in your tree (e.g. sites/all/modules).
 
 * Downlaod Algolia search client PHP library from https://github.com/algolia
   /algoliasearch-client-php and move it into the external libraries location in
   your tree (e.g /sites/all/libraries). From that location, the 
   algoliasearch.php file should be accessible from algolia/algoliasearch.php  
   (e.g. /sites/all/libraries/algolia/algoliasearch.php).
 
 * Enable the module's dependencies on the modules admin page (/admin/modules).


CONFIGURING SEARCH API SERVER AND INDEX
---------------------------------------
 * On the Search API administration page (/admin/config/search/search_api), add
   a new server and check the "Enabled" checkbox. In the "ALGOLIA" section, fill
   in your Application ID and API key found in your Algolia dashboard on 
   https://www.algolia.com.
 
 * On the Search API administration page (/admin/config/search/search_api), add
   a new index, enable it and select the server you just created in the previous
   section. The index name provided will be used to create a new index on the
   Algolia platform. Please read the "Known problems" section of the README.txt
   file for the latest updates about the type of entity supported.
 
 * On the "Fields" tab of your index
   (/admin/config/search/search_api/index/[YOUR INDEX NAME]/fields), check all
   the fields you want to have indexed in the Algolia index. At the very least,
   the entity ID field for the indexed entity type needs to be checked off (nid
   for nodes, uid for users, etc.). Please read the "Known problems" section of
   the README.txt file for the latest updates about the type of fields 
   supported.
 
 * On the "Filters" of your index (/admin/config/search/search_api/index/[YOUR
   INDEX NAME]/workflow), select the filters you want to apply before the data 
   is being sent to Algolia's servers. A good starting combination could be 
   "Bundle filter" (allowing you to index entities of certain bundles only (or 
   content types in the node realm)), "Node access" and "Exclude unpublished 
   nodes". Please read the "Known problems" section of the README.txt file for 
   the latest updates about the type of filters supported.


INDEXING CONTENT
----------------
* On your newly created index page, (/admin/config/search/search_api/index/[YOUR
  INDEX NAME]), click the "Index now" button. You should start seeing content
  populating the index in the Algolia dashboard on https://www.algolia.com.

File

INSTALL.txt
View source 
  1. INSTALLING MODULES AND LIBRARIES

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

  3.  * Download the module and all of its dependencies. Move them to the contributed

  4.    modules location in your tree (e.g. sites/all/modules).

  5.  

  6.  * Downlaod Algolia search client PHP library from https://github.com/algolia

  7.    /algoliasearch-client-php and move it into the external libraries location in

  8.    your tree (e.g /sites/all/libraries). From that location, the 

  9.    algoliasearch.php file should be accessible from algolia/algoliasearch.php  

  10.    (e.g. /sites/all/libraries/algolia/algoliasearch.php).

  11.  

  12.  * Enable the module's dependencies on the modules admin page (/admin/modules).

  13. 

  14. 

  15. CONFIGURING SEARCH API SERVER AND INDEX

  16. ---------------------------------------

  17.  * On the Search API administration page (/admin/config/search/search_api), add

  18.    a new server and check the "Enabled" checkbox. In the "ALGOLIA" section, fill

  19.    in your Application ID and API key found in your Algolia dashboard on 

  20.    https://www.algolia.com.

  21.  

  22.  * On the Search API administration page (/admin/config/search/search_api), add

  23.    a new index, enable it and select the server you just created in the previous

  24.    section. The index name provided will be used to create a new index on the

  25.    Algolia platform. Please read the "Known problems" section of the README.txt

  26.    file for the latest updates about the type of entity supported.

  27.  

  28.  * On the "Fields" tab of your index

  29.    (/admin/config/search/search_api/index/[YOUR INDEX NAME]/fields), check all

  30.    the fields you want to have indexed in the Algolia index. At the very least,

  31.    the entity ID field for the indexed entity type needs to be checked off (nid

  32.    for nodes, uid for users, etc.). Please read the "Known problems" section of

  33.    the README.txt file for the latest updates about the type of fields 

  34.    supported.

  35.  

  36.  * On the "Filters" of your index (/admin/config/search/search_api/index/[YOUR

  37.    INDEX NAME]/workflow), select the filters you want to apply before the data 

  38.    is being sent to Algolia's servers. A good starting combination could be 

  39.    "Bundle filter" (allowing you to index entities of certain bundles only (or 

  40.    content types in the node realm)), "Node access" and "Exclude unpublished 

  41.    nodes". Please read the "Known problems" section of the README.txt file for 

  42.    the latest updates about the type of filters supported.

  43. 

  44. 

  45. INDEXING CONTENT

  46. ----------------

  47. * On your newly created index page, (/admin/config/search/search_api/index/[YOUR

  48.   INDEX NAME]), click the "Index now" button. You should start seeing content

  49.   populating the index in the Algolia dashboard on https://www.algolia.com.