doc/dev-install.md

   1 The lui-solr repository offers two ways for developers to run lui-solr
   2 out of the checked out git repository to test changes in schema and
   3 Solr core configuration.
   4
   5 Installation
   6 ============
   7
   8 Installing in userspace on the developer's system (Linux and MacOS)
   9 -------------------------------------------------------------------
  10
  11 ### Prerequisites
  12
  13 * lui-solr is a repackaging of Solr 6.x, which requires Java 8
  14
  15 ### Installation
  16
  17 * The 'dev-install.sh' script in the root of the repository working
  18   directory unpacks Solr into the working directory and links the
  19   configuration files from the 'conf/solr' directory into the Solr
  20   installation.
  21
  22 * After running dev-install.sh, the Solr installation can be
  23   controlled from the 'solr-<version>/bin/solr' script. Examples:
  24
  25 ```
  26      $ solr-6.1.0/bin/solr start
  27      $ solr-6.1.0/bin/solr stop
  28
  29 ```
  30
  31 * The developer can work directly with the files in the 'conf/solr'
  32   directory.
  33
  34 * NOTE: do not commit the files in the 'solr-<version>/' directory to
  35   the repository!
  36
  37 Installing in a VM using VirtualBox, Vagrant, and Ansible
  38 ---------------------------------------------------------
  39
  40 The repository includes a Vagrantfile and an Ansible playbook
  41 ('dev-deploy.yml') to build a VM with Debian Jessie and deploy
  42 lui-solr to it.
  43
  44 ### Prerequisites
  45
  46 * VirtualBox <https://www.virtualbox.org/>
  47
  48 * Vagrant <https://www.vagrantup.com/>
  49
  50 * Ansible <http://www.ansible.com>,
  51   <http://docs.ansible.com/ansible/intro_installation.html>
  52
  53 ### Installation
  54
  55 * From the working directory:
  56
  57 ```
  58      vagrant up
  59
  60 ```
  61
  62 The files in the 'conf/solr' directory will control the Solr
  63 installation on the virtual machine.