Update README for archival
[reddit.git] / solr / README.md
blob1365deae3c20f67e6b91451406bcc3db3a863018
1 ## Solr Search Provider for Reddit
3 The Solr search provider lets you run Reddit's search on your own Solr server.
6 ### Quickstart
8 To set up your own solr instance:
10 ```
11 sudo apt-get -y install solr-tomcat
12 sudo ln -s /path/to/reddit/solr/schema.xml /usr/share/solr/conf
13 sudo service tomcat6 start
14 ```
16 You should now be able to connect to Solr at http://127.0.0.1:8080
18 To configure reddit to use Solr for search, set the search provider to **solr**
19 in your .ini file:
21 ```
22 search_provider = solr
23 ```
25 Then add the following config lines:
26 ```
27 # version of solr service--versions 1.x and 4.x have been tested. 
28 # only the major version number matters here
29 solr_version = 1
30 # solr search service hostname or IP
31 solr_search_host = 127.0.0.1
32 # hostname or IP for link upload
33 solr_doc_host = 127.0.0.1
34 # hostname or IP for subreddit search
35 solr_subreddit_search_host = 127.0.0.1
36 # hostname or IP subreddit upload
37 solr_subreddit_doc_host = 127.0.0.1
38 # solr port (assumed same on all hosts)
39 solr_port = 8080
40 # solr4 core name (not used with Solr 1.x)
41 solr_core = collection1
42 # default batch size 
43 # limit is hard-coded to 1000
44 # set to 1 for testing
45 solr_min_batch = 500
46 # optionally, you may select your solr query parser here
47 # see documentation for your version of Solr
48 solr_query_parser = 
49 ```
51 ### Notes
53 If you build Solr from source, the default port will be 8983.