Skip to content

Commit f603862

Browse files
committed
5558 Add features, installation and more sections to readme, thanks @sriesterer
1 parent 4d657d4 commit f603862

File tree

1 file changed

+82
-2
lines changed

1 file changed

+82
-2
lines changed

README.md

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,82 @@
1-
# solr-magento1-base
2-
Free Solr Module for Magento 1 for greatly improved search results
1+
![IntegerNet_Solr Logo](https://www.integer-net.de/wp-content/uploads/2012/11/integernet-solr-logo-small.png)
2+
3+
# IntegerNet_Solr Free
4+
This is a free extension to integrate Solr as a product search in an online store running on Magento Community
5+
Edition 1.7 - 1.9.
6+
7+
## Features
8+
9+
### Fast Search Results
10+
The main feature of this is extension is the integration of Solr as a product search in your Magento store.
11+
Solr is a lot faster as a search engine than Magento's native MySQL search. Also, the search algorith is better,
12+
so search results are more relevant.
13+
14+
### Fuzzy Search
15+
The search algorithm performs a fuzzy search to help with usability. When you have typos or misspellings in
16+
your search request, the fuzzy search will look for similar words, increasing the chance of finding a match.
17+
18+
### Boost Products or Attributes
19+
20+
Use your catalog search as a marketing feature to increase the sales of certain products. You can either select
21+
individual or a bunch of products to boost, or you can boost an attribute. Whenever one of these boosted
22+
products or attributes are a match with the search term, they are ranked higher than usual.
23+
24+
## Requirements
25+
- Magento Community Edition 1.7 to 1.9
26+
- Solr 4.x to 6.x
27+
- PHP 5.3 to 7.0
28+
29+
## Installation
30+
1. Install Solr and create at least one working core
31+
2. Copy the files from the solr_conf dir of the module repository to the conf dir of your Solr core
32+
3. Reload the Solr core (or all of Solr)
33+
4. (If activated: deactivate the Magento compiler)
34+
5. If using **Composer**: Just add "integer-net/solr-magento1" to the list of requirements in your composer.json.
35+
**Otherwise**: Download the archive from the [Releases Page](https://github.com/integer-net/solr-magento1/releases).
36+
Copy the files and directories from the src directory of the module repository into your Magento installation.
37+
**Attention**: You will need the files of two more repositories: The
38+
[IntegerNet_Solr base library](https://github.com/integer-net/solr-base) and the
39+
[Aoe_LayoutConditions module](https://github.com/AOEpeople/Aoe_LayoutConditions). They are already contained in
40+
the release archive.
41+
6. Clear the Magento cache
42+
7. (Recompile and reactivate the Magento compiler – it is not recommended to use the compiler mode of Magento,
43+
independent of the IntegerNet_Solr module)
44+
8. Go to the Magento backend, go to System -> Configuration -> Solr
45+
9. Enter the Solr access data and configure the module (see
46+
[Documentation](https://www.integer-net.com/solr-magento/documentation/) for more information - you will also
47+
find an explanation there about how to find out the correct access data)
48+
10. Click "Save Configuration". The connection to the Solr server will automatically be tested. You’ll get a
49+
success or error message about that.
50+
11. Reindex the integernet\_solr index. We recommend doing this via shell. Go to the shell dir and call
51+
`php -f indexer.php -- --reindex integernet_solr`
52+
12. Submit a search request with a slight typo on your page. The search result page should show matching products.
53+
54+
## Configuration
55+
The extension comes with a complete installation and configuration guide. Every configuration option is
56+
explained. You can find it on our website:
57+
**[Documentation](https://www.integer-net.com/solr-magento/documentation/)**
58+
59+
## Modification
60+
You are welcome to modify the extension as you like. To make it easier, we have implemented a number of events.
61+
For a quick start and an example, please have a look at our blog post:
62+
[How to Use Events to Tweak Solr Search](https://www.integer-net.com/utilizing-events-of-integernet_solr-an-example/)
63+
64+
## License
65+
The extension IntegerNet_Solr Free is published under the license GNU Lesser Public General License (LGPL v3).
66+
You can find the license in the file [License](https://github.com/integer-net/solr-magento1/blob/master/LICENSE).
67+
For more information and an explanation of this license, please see the following article:
68+
[Information on GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.en.html)
69+
70+
## Contributing
71+
If you would like to contribute to this extension, please fork the repository.
72+
Any pull requests are warmly welcome.
73+
74+
## Support
75+
Please note that this is a free extension. We do not provide individual customer support for this extension.
76+
If you find a bug, please open a GitHub issue.
77+
78+
## Upgrade
79+
IntegerNet\_Solr Free is an offspring of **IntegerNet_Solr Pro**, our powerful Solr extension for Magento.
80+
It offers more features, such as an extensive autosuggest window, multiselect filters, product lists in
81+
categories loaded via Solr and support of Magento Enterprise Edition. For more information, please visit our
82+
[website](https://www.integer-net.com/solr-magento/).

0 commit comments

Comments
 (0)