Documentation update.
authorWayne Schneider <wayne@indexdata.com>
Fri, 29 Jul 2016 17:01:16 +0000 (12:01 -0500)
committerWayne Schneider <wayne@indexdata.com>
Fri, 29 Jul 2016 17:01:16 +0000 (12:01 -0500)
doc/debian-install.md
doc/dev-install.md
doc/upgrade.md

index 4848314..2c24c12 100644 (file)
@@ -32,7 +32,7 @@ apt keyring.
 ```
 
 * Masterkey LUI stores its Solr indexes by default in
 ```
 
 * Masterkey LUI stores its Solr indexes by default in
-/var/lib/masterkey/lui/data.  Ensure this partition is large enough to
+/var/lib/masterkey/lui/solr.  Ensure this partition is large enough to
 accomodate your Solr indexes.
 
 Installation
 accomodate your Solr indexes.
 
 Installation
@@ -40,7 +40,7 @@ Installation
 
 The lui-solr package installs a Solr binary installation in
 /usr/share/masterkey/lui, a default configuration in
 
 The lui-solr package installs a Solr binary installation in
 /usr/share/masterkey/lui, a default configuration in
-/etc/masterkey/lui, a data directory in /var/lib/masterkey/lui/data,
+/etc/masterkey/lui/solr, a data directory in /var/lib/masterkey/lui/solr,
 and logs in /var/log/masterkey/lui. It creates the "lui-solr" service
 and installs an init script for startup. The Solr server runs by
 default on port 8983, and processes and files are owned by the
 and logs in /var/log/masterkey/lui. It creates the "lui-solr" service
 and installs an init script for startup. The Solr server runs by
 default on port 8983, and processes and files are owned by the
@@ -60,7 +60,7 @@ default on port 8983, and processes and files are owned by the
 depends on several factors, including the total amount of RAM
 available on the system and the size of your indexes.  The default of
 512m, however, is likely too low for production. Edit
 depends on several factors, including the total amount of RAM
 available on the system and the size of your indexes.  The default of
 512m, however, is likely too low for production. Edit
-/etc/masterkey/lui/lui-solr.in.sh and increase 'SOLR_HEAP'.  Example:
+/etc/masterkey/lui/solr/lui-solr.in.sh and increase 'SOLR_HEAP'.  Example:
 
 ```
      SOLR_HEAP="2048m"
 
 ```
      SOLR_HEAP="2048m"
index 4bcd020..7fe1f02 100644 (file)
@@ -16,7 +16,7 @@ Installing in userspace on the developer's system (Linux and MacOS)
 
 * The 'dev-install.sh' script in the root of the repository working
   directory unpacks Solr into the working directory and links the
 
 * The 'dev-install.sh' script in the root of the repository working
   directory unpacks Solr into the working directory and links the
-  configuration files from the 'conf/' directory into the Solr
+  configuration files from the 'conf/solr' directory into the Solr
   installation.
 
 * After running dev-install.sh, the Solr installation can be
   installation.
 
 * After running dev-install.sh, the Solr installation can be
@@ -28,7 +28,7 @@ Installing in userspace on the developer's system (Linux and MacOS)
 
 ```
 
 
 ```
 
-* The developer can work directly with the files in the 'conf/'
+* The developer can work directly with the files in the 'conf/solr'
   directory.
 
 * NOTE: do not commit the files in the 'solr-<version>/' directory to
   directory.
 
 * NOTE: do not commit the files in the 'solr-<version>/' directory to
@@ -59,5 +59,5 @@ lui-solr to it.
 
 ```
 
 
 ```
 
-The files in the 'conf/' directory will control the Solr
+The files in the 'conf/solr' directory will control the Solr
 installation on the virtual machine.
 installation on the virtual machine.
index 0a9d0f8..86791e1 100644 (file)
@@ -32,7 +32,7 @@ Major Changes
   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
   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/lui-solr.in.sh (look for the SOLR_PORT variable).
+  /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
 
 * Solr 5 no longer has the feature of serving up a default core
   ("collection1") on the root of the web
@@ -40,14 +40,14 @@ Major Changes
   "lui", addressable at http://localhost:8983/solr/lui. This may also
   require changes to Harvester and search target settings.
 
   "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-home
+  * Cores are defined in the /etc/masterkey/lui/solr/solr-home
     directory. Indexes are stored by default in
     directory. Indexes are stored by default in
-    /var/lib/masterkey/lui/data/<core-name>.
+    /var/lib/masterkey/lui/solr/<core-name>.
 
 * There are no longer separate packages for master and slave
   configurations. To configure a lui-solr core as a slave, edit the
   configuration file
 
 * There are no longer separate packages for master and slave
   configurations. To configure a lui-solr core as a slave, edit the
   configuration file
-  /etc/masterkey/lui/solr-home/<core-name>/conf/solrconfig.xml. Look
+  /etc/masterkey/lui/solr/solr-home/<core-name>/conf/solrconfig.xml. Look
   for the "/replication" requestHandler.
 
 * SolrCloud support (which was mostly aspirational, to be honest) is
   for the "/replication" requestHandler.
 
 * SolrCloud support (which was mostly aspirational, to be honest) is
@@ -56,15 +56,15 @@ Major Changes
 * Package layout has changed somewhat, to better conform with the
   Linux FSH and with other applications in the MasterKey Platform:
 
 * Package layout has changed somewhat, to better conform with the
   Linux FSH and with other applications in the MasterKey Platform:
 
-  * All configuration files are now found in /etc/masterkey/lui. Core
+  * All configuration files are now found in /etc/masterkey/lui/solr. Core
     configuration (schema and solrconfig) are in
     configuration (schema and solrconfig) are in
-    /etc/masterkey/lui/solr-home. Solr environment and logging are
-    controlled by /etc/masterkey/lui/lui-solr.in.sh and
-    /etc/masterkey/lui/log4j.properties, respectively.
+    /etc/masterkey/lui/solr/solr-home. Solr environment and logging are
+    controlled by /etc/masterkey/lui/solr/lui-solr.in.sh and
+    /etc/masterkey/lui/solr/log4j.properties, respectively.
 
   * /usr/share/masterkey/lui contains only the runtime files for Solr.
 
 
   * /usr/share/masterkey/lui contains only the runtime files for Solr.
 
-  * Data files for Solr cores are in /var/lib/masterkey/lui/data.
+  * Data files for Solr cores are in /var/lib/masterkey/lui/solr.
 
   * Logs for lui-solr are in /var/log/masterkey/lui.
 
 
   * Logs for lui-solr are in /var/log/masterkey/lui.
 
@@ -83,7 +83,7 @@ Upgrading an existing lui-solr installation
    /usr/share/masterkey/lui/solr4/<master|slave>/conf/
    directory. These will need to be backported into the configuration
    for the Solr 5 core (installed in
    /usr/share/masterkey/lui/solr4/<master|slave>/conf/
    directory. These will need to be backported into the configuration
    for the Solr 5 core (installed in
-   /etc/masterkey/lui/solr-home/lui/conf/ by the masterkey-lui-solr5
+   /etc/masterkey/lui/solr/solr-home/lui/conf/ by the masterkey-lui-solr5
    package).
 
 4. Remove any masterkey-lui-solr4* packages installed on the
    package).
 
 4. Remove any masterkey-lui-solr4* packages installed on the
@@ -100,7 +100,7 @@ Upgrading an existing lui-solr installation
    debian-install.md.
 
 6. Make any updates necessary to the configuration files in
    debian-install.md.
 
 6. Make any updates necessary to the configuration files in
-   /etc/masterkey/lui and restart the lui-solr service. You should be
+   /etc/masterkey/lui/solr and restart the lui-solr service. You should be
    able to point to your existing index by editing
    able to point to your existing index by editing
-   /etc/masterkey/lui/solr-home/lui/solrconfig.xml and altering the
+   /etc/masterkey/lui/solr/solr-home/lui/solrconfig.xml and altering the
    entry for `<dataDir>`.
    entry for `<dataDir>`.