Add support for Solr 6.1.0. Update dev deployment, documentation.
[lui-solr.git] / doc / upgrade.md
index 86791e1..5a53470 100644 (file)
@@ -1,44 +1,45 @@
-The masterkey-lui-solr5 package contains a number of changes from the
-masterkey-lui-solr4 family of packages. The good news is that
-**indexes created with masterkey-lui-solr4 are compatible with
-masterkey-lui-solr5**.
+The masterkey-lui-solr5/masterkey-lui-solr6 packages contain a number
+of changes from the masterkey-lui-solr4 family of packages. The good
+news is that **indexes created with masterkey-lui-solr4 are compatible
+with masterkey-lui-solr5**.
 
-That said, the move to Solr 5 requires significant changes to
+That said, the move to Solr 5/6 requires significant changes to
 schema.xml and to solrconfig.xml, so older versions of those files are
 not compatible. Any customizations will need to be backported into
 those files. Also, because of the schema and solrconfig
-incompatibilities, Solr 4- and Solr 5-based installations cannot be in
-a replication relationship together (master-slave pairs must be all
-Solr 4 or all Solr 5).
+incompatibilities, Solr 4- and Solr 5/6-based installations cannot be
+in a replication relationship together (master-slave pairs must be all
+Solr 4 or all Solr 5/6).
 
 Major Changes
 =============
 
-* masterkey-lui-solr5 is based on Solr 5, which does not require a
-  separate Java servlet container. That simplifies packaging and
-  installation significantly, as there is no longer any need for
-  Tomcat integration. There is only one package to install,
-  masterkey-lui-solr5.
-
-* masterkey-lui-solr5 is installed as a separate service, since it no
-  longer runs under Tomcat. The service name is "lui-solr", and files
-  and processes are owned by the "lui-solr" user (created as part of
-  the package installation).
-
-* The default port for masterkey-lui-solr5 is the same as the Solr 5
-  default port, 8983, to prevent conflicts when upgrading a lui-solr
-  installation that is on the same system as a MasterKey Harvester
-  installation (which runs by default under Tomcat on port 8080). This
-  may require changes to Harvester datasource settings and/or search
-  target settings for existing installations. The Solr port can be set
-  by the user in the configuration file
-  /etc/masterkey/lui/solr/lui-solr.in.sh (look for the SOLR_PORT variable).
-
-* Solr 5 no longer has the feature of serving up a default core
-  ("collection1") on the root of the web
-  application. The masterkey-lui-solr5 installs a default core named
-  "lui", addressable at http://localhost:8983/solr/lui. This may also
-  require changes to Harvester and search target settings.
+* masterkey-lui-solr5/masterkey-lui-solr6 are based on Solr 5/6, which
+  do not require a separate Java servlet container. That simplifies
+  packaging and installation significantly, as there is no longer any
+  need for Tomcat integration. There is only one package to install,
+  masterkey-lui-solr5 or masterkey-lui-solr6.
+
+* masterkey-lui-solr5/masterkey-lui-solr6 are installed as a separate
+  service, since they no longer runs under Tomcat. The service name is
+  "lui-solr", and files and processes are owned by the "lui-solr" user
+  (created as part of the package installation).
+
+* The default port for masterkey-lui-solr5/masterkey-lui-solr6 is the
+  same as the Solr default port, 8983, to prevent conflicts when
+  upgrading a lui-solr installation that is on the same system as a
+  MasterKey Harvester installation (which runs by default under Tomcat
+  on port 8080). This may require changes to Harvester datasource
+  settings and/or search target settings for existing
+  installations. The Solr port can be set by the user in the
+  configuration file /etc/masterkey/lui/solr/lui-solr.in.sh (look for
+  the SOLR_PORT variable).
+
+* Solr 5/6 no longer have the feature of serving up a default core
+  ("collection1") on the root of the web application. The
+  masterkey-lui-solr packages install a default core named "lui",
+  addressable at http://localhost:8983/solr/lui. This may also require
+  changes to Harvester and search target settings.
 
   * Cores are defined in the /etc/masterkey/lui/solr/solr-home
     directory. Indexes are stored by default in
@@ -96,11 +97,12 @@ Upgrading an existing lui-solr installation
    masterkey-lui-solr4-master-tomcat8, and
    masterkey-lui-solr4-slave-tomcat8
 
-5. Install the masterkey-lui-solr5 package using the instructions in
-   debian-install.md.
+5. Install the masterkey-lui-solr5 or the masterkey-lui-solr6 package
+   using the instructions in debian-install.md.
 
 6. Make any updates necessary to the configuration files in
    /etc/masterkey/lui/solr and restart the lui-solr service. You should be
    able to point to your existing index by editing
    /etc/masterkey/lui/solr/solr-home/lui/solrconfig.xml and altering the
    entry for `<dataDir>`.
+