doc/debian-install.md

   1 This document describes the installation of the Index Data Local
   2 Unified Index (lui-solr) on Debian Linux
   3
   4 Prerequisites
   5 =============
   6
   7 * lui-solr is based on Solr 5.x, which requires Java 7. The package
   8 depends on openjdk-7-jdk.
   9
  10 Pre-installation
  11 ================
  12
  13 * Add the Index Data apt repository to your system.  Add the following
  14 content to /etc/apt/sources.list.d/indexdata.list:
  15
  16 ```
  17      deb http://ftp.indexdata.dk/debian jessie main restricted
  18      deb-src http://ftp.indexdata.dk/debian jessie main restricted
  19
  20 ```
  21
  22 * The 'restricted' repo requires IP authentication.  Please send
  23 access requests to 'support@indexdata.com' if necessary.
  24
  25 * Index Data packages are signed with a GPG key.  Add the key to your
  26 apt keyring.
  27
  28 ```
  29      wget http://ftp.indexdata.com/pub/debian/indexdata.asc -O - | sudo apt-key add -
  30      sudo apt-get update
  31
  32 ```
  33
  34 * Masterkey LUI stores its Solr indexes by default in
  35 /var/lib/masterkey/lui/solr.  Ensure this partition is large enough to
  36 accomodate your Solr indexes.
  37
  38 Installation
  39 ============
  40
  41 The lui-solr package installs a Solr binary installation in
  42 /usr/share/masterkey/lui, a default configuration in
  43 /etc/masterkey/lui/solr, a data directory in /var/lib/masterkey/lui/solr,
  44 and logs in /var/log/masterkey/lui. It creates the "lui-solr" service
  45 and installs an init script for startup. The Solr server runs by
  46 default on port 8983, and processes and files are owned by the
  47 "lui-solr" user.
  48
  49 * Install the masterkey-lui-solr5 package:
  50
  51 ```
  52      sudo apt-get install masterkey-lui-solr5
  53
  54 ```
  55
  56   This will install and start up the lui-solr service with the default
  57   configuration.
  58
  59 * Increase the JVM heap size for Solr.  The ideal setting
  60 depends on several factors, including the total amount of RAM
  61 available on the system and the size of your indexes.  The default of
  62 512m, however, is likely too low for production. Edit
  63 /etc/masterkey/lui/solr/lui-solr.in.sh and increase 'SOLR_HEAP'.  Example:
  64
  65 ```
  66      SOLR_HEAP="2048m"
  67
  68 ```
  69
  70   See the comments in lui-solr.in.sh for more examples of memory and
  71   garbage collection fine-tuning.
  72
  73 * Restart the lui-solr service.
  74
  75 * Verify that Solr is running normally by connecting to the Solr Admin
  76 console on port 8983:
  77
  78 ```
  79      curl http://localhost:8983/solr
  80
  81 ```
  82
  83 * Solr logs are available at /var/log/masterkey/lui/solr.log.