Documentation updates.

[lui-solr.git] / doc / debian-install.md

diff --git a/doc/debian-install.md b/doc/debian-install.md
new file mode 100644 (file)
index 0000000..4848314
--- /dev/null
+++ b/doc/debian-install.md
@@ -0,0 +1,83 @@
+This document describes the installation of the Index Data Local
+Unified Index (lui-solr) on Debian Linux
+
+Prerequisites
+=============
+
+* lui-solr is based on Solr 5.x, which requires Java 7. The package
+depends on openjdk-7-jdk.
+
+Pre-installation
+================
+
+* Add the Index Data apt repository to your system.  Add the following
+content to /etc/apt/sources.list.d/indexdata.list:
+
+```
+     deb http://ftp.indexdata.dk/debian jessie main restricted
+     deb-src http://ftp.indexdata.dk/debian jessie main restricted
+
+```
+
+* The 'restricted' repo requires IP authentication.  Please send
+access requests to 'support@indexdata.com' if necessary.
+
+* Index Data packages are signed with a GPG key.  Add the key to your
+apt keyring.
+
+```
+     wget http://ftp.indexdata.com/pub/debian/indexdata.asc -O - | sudo apt-key add -
+     sudo apt-get update
+
+```
+
+* Masterkey LUI stores its Solr indexes by default in
+/var/lib/masterkey/lui/data.  Ensure this partition is large enough to
+accomodate your Solr indexes.
+
+Installation
+============
+
+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,
+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
+"lui-solr" user.
+
+* Install the masterkey-lui-solr5 package:
+
+```
+     sudo apt-get install masterkey-lui-solr5
+
+```
+
+  This will install and start up the lui-solr service with the default
+  configuration.
+
+* Increase the JVM heap size for Solr.  The ideal setting
+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:
+
+```
+     SOLR_HEAP="2048m"
+
+```
+
+  See the comments in lui-solr.in.sh for more examples of memory and
+  garbage collection fine-tuning.
+
+* Restart the lui-solr service.
+
+* Verify that Solr is running normally by connecting to the Solr Admin
+console on port 8983:
+
+```
+     curl http://localhost:8983/solr
+
+```
+
+* Solr logs are available at /var/log/masterkey/lui/solr.log.