Drupal 7.27.1 and Pressflow 6.31.1
[project/barracuda.git] / docs / SOLR.txt
1
2  To enable Apache Solr Search feature for any site on your BOA server,
3  please download and enable either Apache Solr Search Integration
4  module with required third party library, as explained in its readme,
5  or download and enable Search API Solr search module (D7 only).
6
7  https://drupal.org/project/apachesolr (6.x-1.7 or newer)
8  https://drupal.org/project/search_api_solr (7.x-1.0-rc3 or newer)
9
10  BOA system supports both Apache Solr Search Integration module
11  and Search API Solr search module (used by default), and you have
12  a few options to use it with different versions of Apache Solr
13  and Jetty server, for maximum backward and future compatibility.
14
15  By default, all pre-configured Solr Cores come with required
16  solrconfig.xml, schema.xml and protwords.txt files compatible
17  with Solr 3.x config series from Search API Solr search module
18  for Solr 3.x and Solr 4.x, or Solr 1.x config series for Solr 1.x
19
20  You may want to replace them if you wish to use Solr with Drupal 6
21  sites, which require Apache Solr Search Integration module instead.
22
23  You should configure each core separately to use correct version
24  by uploading respective solrconfig.xml, schema.xml and protwords.txt
25  files to the solr{1,3,4}/core*/conf directory and restarting correct
26  Jetty instance with command `service jetty{7,8,9} restart`.
27
28  NOTE: If your site was already configured to use any of those
29        modules, you must delete its search index (not just rebuild it)
30        or the site and the search indexing will fail to work properly.
31
32  In your Solr configuration there are ready to use 10 separate
33  cores, since you need to use one core per site to avoid
34  displaying search results from different sites on any site
35  with enabled Solr module.
36
37  The access credentials you should use are as follows:
38
39  Solr host ........: 127.0.0.1
40
41  Solr port ........: 8077 (for Solr 1.x with Jetty 7)
42  Solr port ........: 8088 (for Solr 3.x with Jetty 8)
43  Solr port ........: 8099 (for Solr 4.x with Jetty 8 or 9 on Precise/Wheezy)
44  Solr port ........: 8080 (for Solr 1.x with Jetty 7 migrated from Tomcat)
45
46  Solr path ........: solr/core0 (configured in solr.xml)
47  Solr path ........: solr/core1 (configured in solr.xml)
48
49  Solr path ........: solr/core2 (not configured in solr.xml)
50  Solr path ........: solr/core3 (not configured in solr.xml)
51  Solr path ........: solr/core4 (not configured in solr.xml)
52  Solr path ........: solr/core5 (not configured in solr.xml)
53  Solr path ........: solr/core6 (not configured in solr.xml)
54  Solr path ........: solr/core7 (not configured in solr.xml)
55  Solr path ........: solr/core8 (not configured in solr.xml)
56  Solr path ........: solr/core9 (not configured in solr.xml)
57
58  To add more cores, you need to:
59
60  1. Create a copy of example core directory:
61     cp -ar /opt/solr3/core0 /opt/solr3/core11
62
63  2. Add this new core in the solr.xml file:
64     /opt/solr1/solr.xml (for Solr 1.x with Jetty 7)
65     /opt/solr3/solr.xml (for Solr 3.x with Jetty 8)
66     /opt/solr4/solr.xml (for Solr 4.x with Jetty 8 or 9 on Precise/Wheezy)
67
68  3. Restart correct Jetty instance:
69     service jetty7 restart (for Solr 1.x with Jetty 7)
70     service jetty8 restart (for Solr 3.x with Jetty 8)
71     service jetty9 restart (for Solr 4.x with Jetty 8 or 9 on Precise/Wheezy)
72
73  You can also rename the "core name" in the file:
74    /opt/solr{1,3,4}/solr.xml
75  to avoid using them by not authorized sites owners:
76
77    <cores adminPath="/admin/cores">
78      <core name="325o45758" instanceDir="core0" />
79      <core name="w44337377" instanceDir="core1" />
80    </cores>
81
82  To install one or more supported versions of Apache Solr
83  with corresponding Jetty version, just add correct
84  keyword to the _XTRAS_LIST in /root/.barracuda.cnf
85
86  SR1 (for Solr 1.x with Jetty 7)
87  SR3 (for Solr 3.x with Jetty 8)
88  SR4 (for Solr 4.x with Jetty 8 or 9 on Precise/Wheezy)
89
90  It is even possible to add them *all* on upgrade when
91  you are already running now deprecated Tomcat 6 with Solr 1.x,
92  because new, Jetty based Solr instances use separate
93  ports and directories.
94
95  TOMCAT TO JETTY MIGRATION NOTE:
96
97  To migrate existing Solr cores from Tomcat 6 to Jetty 7,
98  add special variable _TOMCAT_TO_JETTY=YES in your config file
99  /root/.barracuda.cnf and run barracuda up-{stable,head} upgrade.
100
101  It will migrate all cores as-is, so they will be available
102  on the same port 8080 previously used by Tomcat. It will also
103  automatically install Jetty 7 with Solr 1.4.1 for you,
104  even if you forgot to add required SR1 in the _XTRAS_LIST.
105