Web Site: If you have any questions, please contact us. MT Search Elastic Search for Magento Version 1.0.0 for Magento 1.9.x Download: http:///elasticsearch 2014 1
Table of Contents 1. Introduction... 3 2. Installation... 4 2.1 Manual Installation... 4 2.2 Installation with Magento Downloader... 6 3. Configuration... 7 3.1 General configuration... 7 3.2 Search Settings... 7 3.3 Auto Suggestion... 8 3.4 Crontab configuration... 8 2
1. Introduction MT Search extension is based on Elasticsearch. Elasticsearch is a FREE, powerful open source search and analytics engine. Stackoverflow, GitHub, SoundCloud, Mozila and more brands are using Elasticsearch s engine. More about Elasticsearch: http://www.elasticsearch.org/ MT search is supporting the following languages: Arabic, Armenian, Basque, Brazilian, Bulgarian, Catalan, Chinese, Cjk, Czech, Danish, Dutch, English, Finnish, French, Galician, German, Greek, Hindi, Hungarian, Indonesian, Irish, Italian, Latvian, Norwegian, Persian, Portuguese, Romanian, Russian, Sorani, Spanish, Swedish, Turkish, Thai. If you don t find your language, you can use standard language analyzer. MT Search features: - MT Search is based on Elasticsearch. - Returns relevant results. - Singular/Plural search. - Stopwords. - Search by: name, description, categories, manufacturer, sku, attributes (color, size, etc...). - Faster than Magento search. - Flexible configuration. - Auto Suggestion function. - Multi language support. - Works on Multi store. 3
2. Installation Notice: Ensure that in your web server is installed Elasticsearch. - Connect to your server with SSH client. - Run command : curl -X GET http://localhost:9200/ You should get response from Elasticsearch with status 200. If something failed, please contact with your server administrator or our support team. 2.1 Manual Installation Please follow next steps: 2.1.1 Extract MT_ElasticSearch-x.x.x.tgz archive 2.1.2 Move file to your web server. You shouldn t need to change existing files. 2.1.3 Clear your store s cache. How to do it: Admin Panel > System > Cache Management > Select All >Actions Refresh: Submit 2.1.4 Go to Admin Panel >System>Configuration>MAGETREND EXTENSIONS >Elastic Search 2.1.5 If you see picture 2.1, jump to step 2.1.7! Picture 2.1 2.1.6 If you get an error as picture 2.2, you need to logout and login again in Magento admin panel. Please repeat step 2.1.4. 4
Picture 2.2 2.1.7 If you are using custom theme, then: Copy files from: app\design\frontend\base\default\layout\mt\elasticsearch.xml To app\design\frontend\default\your_theme\layout\mt\elasticsearch.xml Also from: app\design\frontend\base\default\template\mt\elasticsearch\ To app\design\frontend\default\your_theme\template\mt\elasticsearch\ Installation is complete, congratulation! If something failed, please contact our support team. 5
2.2 Installation with Magento Downloader 2.2.1 Go to http://your_store_url/downloader 2.2.2 Login using admin username and password. 2.2.3 Find the section: Direct package file upload > Upload package file. Choose extension archive (MT_ElasticSearch-x.x.x.tgz) and press upload. 2.2.4 Clear your store s cache. How to do it: Admin Panel > System > Cache Management > Select All > Actions: Refresh: Submit 2.2.5 Go to Admin Panel > System >Configuration>MAGETREND EXTENSIONS>Elastic Search. 2.2.6 If you see picture 2.1, jump to step 2.2.8! 2.2.7 If you get an error as picture 2.2, you need to logout and login again in Magento admin panel. Please repeat step 2.2.5. 2.1.8 If you are using custom theme, Copy files from: app\design\frontend\base\default\layout\mt\elasticsearch.xml To app\design\frontend\default\your_theme\layout\mt\elasticsearch.xml Also from: app\design\frontend\base\default\template\mt\elasticsearch\ To app\design\frontend\default\your_theme\template\mt\elasticsearch\ Installation is complete, congratulation! If something failed, please contact our support team. 6
3. Configuration MT Search extension settings are found: Admin Panel > System > Configuration >MAGETREND EXTENSIONS >Elastic Search 3.1 General configuration 3.1.1 Is Active Enable/Disable MTsearch extension. 3.1.2 Include jquery turn off if jquery library already exists. Usually jquery is already included. 3.1.3 Indexer Product Limit Product limit in cron process. More about crontab configuration in paragraph 3.4. 3.1.4 Debug mode turn on if you want to log errors, search queries and results. Log file is in /var/log/elasticsearch.log. 3.2 Search Settings 3.2.1 Host Elasticsearch s host. By default: 127.0.0.1 or localhost. 3.2.2 Port Elasticsearch s port. 3.2.3 Language Choose your store s language. If you don t find your language, leave it empty. 3.2.4 Min Score Search results have relevance score. You can filter search result with this setting. Default min score is 0.15. The higher value means more relevant results but also less results. 3.2.5 Searchable Attributes Add attributes which will be used in search. Often used attributes: -Name - Categories - Manufacturer - SKU - Description - Color - Size Some attributes can be more important, if you add higher weight for them. Weight range: 0 2. If new attributes were added, you will need to update Elasticsearch ("Button: Apply Settings to ElasticSearch"). 7
3.3 Auto Suggestion 3.3.1 Is Active enable/disable suggestion function. 3.3.2 Show Products enable/disable products suggestion. 3.3.3 Result Limit limit number of suggestions. 3.3.4 Show Image show image in suggestions. 3.3.5 Show Price show price in suggestions. 3.3.6 Show Description show description in suggestions. 3.3.7 Description Length limit description size. 3.4 Crontab configuration MT Search is using cron (periodic tasks) for product indexing. It should be run every 5 minutes by default. How to calculate product limit per process: {STORE_COUNT} Your store count. If you have more than 10 000 products, recommended optimal product per process number: 400/{STORE_COUNT } If you have less than 10 000 products, recommended optimal product per process number: 200/{STORE_COUNT} If you have less than 5 000 products, recommended optimal product per process number: 100/{STORE_COUNT} Please enter your choice to "Indexer Product Limit " field (paragraph 3.1.3). GOOD LUCK 8