You are here

Home » API reference » Search API Elasticsearch 7

INSTALL.txt in Search API Elasticsearch 7 

Please note: If you enable Search API Elasticsearch Elastica via Drush, Drush
will automatically attempt to install the library if it is not available.
This is the recommended way of installing the module.

Install Elastica library (with Libraries API)
------------------------

Elastica is an external php library used to communicate with elasticsearch
and required by the search_api_elasticsearch module.

To install it:

Download the archive at [1] and extract it in "sites/all/libraries" or
any other valid path reachable by the Drupal libraries module.

Or

Clone the repository in "sites/all/libraries" or
any other valid path reachable by the Drupal libraries module.

> git clone git://github.com/ruflin/Elastica.git

[1] https://github.com/ruflin/Elastica/archive/v1.0.0.0.tar.gz

If manually installed, the library should reside at "sites/all/libraries/Elastica"
such that the path to the composer.json file is "sites/all/libraries/Elastica/composer.json"
(just used for reference even if you aren't using Composer Manager).

Alternatively, you can use drush to download Elastica in "sites/all/libraries"
or via Composer Manager (if Composer Manager is installed).

> drush download-elastica

Please, also note that if you use drush to install search_api_elasticsearch,
drush will attempt to download Elastica for you if not already present.

> drush pm-enable search_api_elasticsearch


If you uninstall search_api_elasticsearch, you will have to remove the
Elastica library manually.

Install Elastica library (with Composer Manager)
------------------------------------------------

Search API Elasticsearch supports Composer Manager. To use this module with
Composer Manager, you will first need to download and install Composer Manager.

After installing Composer Manager, you will need to rebuild your dependencies
at the following path:

  admin/config/system/composer-manager

If you already have Composer installed, you can then go to sites/default/files/composer
and run the following command:

  composer install

If you don't already have Composer installed, you will need to install it first.
The easiest way is to run the following:

  curl -sS https://getcomposer.org/installer | php
  php composer.phar install

Alternatively, "drush download-elastica" will check for Composer Manager and
attempt to install the library via Composer Manager if available.

File

modules/elastica/INSTALL.txt
View source 
  1. Please note: If you enable Search API Elasticsearch Elastica via Drush, Drush

  2. will automatically attempt to install the library if it is not available.

  3. This is the recommended way of installing the module.

  4. 

  5. Install Elastica library (with Libraries API)

  6. ------------------------

  7. 

  8. Elastica is an external php library used to communicate with elasticsearch

  9. and required by the search_api_elasticsearch module.

  10. 

  11. To install it:

  12. 

  13. Download the archive at [1] and extract it in "sites/all/libraries" or

  14. any other valid path reachable by the Drupal libraries module.

  15. 

  16. Or

  17. 

  18. Clone the repository in "sites/all/libraries" or

  19. any other valid path reachable by the Drupal libraries module.

  20. 

  21. > git clone git://github.com/ruflin/Elastica.git

  22. 

  23. [1] https://github.com/ruflin/Elastica/archive/v1.0.0.0.tar.gz

  24. 

  25. If manually installed, the library should reside at "sites/all/libraries/Elastica"

  26. such that the path to the composer.json file is "sites/all/libraries/Elastica/composer.json"

  27. (just used for reference even if you aren't using Composer Manager).

  28. 

  29. Alternatively, you can use drush to download Elastica in "sites/all/libraries"

  30. or via Composer Manager (if Composer Manager is installed).

  31. 

  32. > drush download-elastica

  33. 

  34. Please, also note that if you use drush to install search_api_elasticsearch,

  35. drush will attempt to download Elastica for you if not already present.

  36. 

  37. > drush pm-enable search_api_elasticsearch

  38. 

  39. 

  40. If you uninstall search_api_elasticsearch, you will have to remove the

  41. Elastica library manually.

  42. 

  43. Install Elastica library (with Composer Manager)

  44. ------------------------------------------------

  45. 

  46. Search API Elasticsearch supports Composer Manager. To use this module with

  47. Composer Manager, you will first need to download and install Composer Manager.

  48. 

  49. After installing Composer Manager, you will need to rebuild your dependencies

  50. at the following path:

  51. 

  52.   admin/config/system/composer-manager

  53. 

  54. If you already have Composer installed, you can then go to sites/default/files/composer

  55. and run the following command:

  56. 

  57.   composer install

  58. 

  59. If you don't already have Composer installed, you will need to install it first.

  60. The easiest way is to run the following:

  61. 

  62.   curl -sS https://getcomposer.org/installer | php

  63.   php composer.phar install

  64. 

  65. Alternatively, "drush download-elastica" will check for Composer Manager and

  66. attempt to install the library via Composer Manager if available.

  67.