Documentation updates.

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

diff --git a/doc/dev-install.md b/doc/dev-install.md
new file mode 100644 (file)
index 0000000..2d3d481
--- /dev/null
+++ b/doc/dev-install.md
@@ -0,0 +1,63 @@
+The lui-solr repository offers two ways for developers to run lui-solr
+out of the checked out git repository to test changes in schema and
+Solr core configuration.
+
+Installation
+============
+
+Installing in userspace on the developer's system (Linux and MacOS)
+-------------------------------------------------------------------
+
+### Prerequisites
+
+* lui-solr is a repackaging of Solr 5.x, which requires Java 7
+
+### Installation
+
+* 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
+  installation.
+
+* After running dev-install.sh, the Solr installation can be
+  controlled from the 'solr-<version>/bin/solr' script. Examples:
+
+```
+     $ solr-5.5.1/bin/solr start
+     $ solr-5.5.1/bin/solr stop
+
+```
+
+* The developer can work directly with the files in the 'conf/'
+  directory.
+
+* NOTE: do not commit the files in the 'solr-<version>/' directory to
+  the repository!
+
+Installing in a VM using VirtualBox, Vagrant, and Ansible
+---------------------------------------------------------
+
+The repository includes a Vagrantfile and an Ansible playbook
+('dev-deploy.yml') to build a VM with Debian Jessie and deploy
+lui-solr to it.
+
+### Prerequisites
+
+* VirtualBox <https://www.virtualbox.org/>
+
+* Vagrant <https://www.vagrantup.com/>
+
+* Ansible <http://www.ansible.com>,
+  <http://docs.ansible.com/ansible/intro_installation.html>
+
+### Installation
+
+* From the working directory:
+
+```
+     vagrant up
+
+```
+
+  The files in the 'conf/' directory will control the Solr
+  installation on the virtual machine.