Initial setup

First clone this repository onto the hard drive of your machine (a network location would be too slow). For example:

C:
cd \users\tbmg73
git clone https://source.dur.ac.uk/university-library/vagrant-spotlight

This will create a directory called vagrant-spotlight. If you need to use a different name, for example if you want a second copy to experiment with, give the name of the directory to be created at the end of the command:

git clone https://source.dur.ac.uk/university-library/vagrant-spotlight newdirectoryname

The virtual machine created by the Vagrantfile is called "spotlight-dev-vm" by default. VM names in VirtualBox have to be unique, so if you want a second copy to experiment with, edit the Vagrantfile to change the v.name setting on line 81 before you go any further. You may also want to adjust the memory available to the VM (defaults to 8GB) on the next line.

For the initial setup, just execute vagrant up.

Once this has run you can get onto your server by running vagrant ssh.

First we need to edit a generated file which has a fault in it. This issue in GitHub gave us the clue to remove a line. Edit ./dur-spotlight/app/assets/config/manifest.js and remove the line that says //=link application.js

There is also a line where "//=" appears part way through. Add a line break before the "//=".

Then issue the following commands:

cd ~/dur-spotlight
rails server -b 0.0.0.0

You should now be able to access Spotlight. Click to sign in, and then use the "Sign up" link under the login box to create your first user.

Manual starting of background processes

The scripts now should start the Redis server, Solr and Sidekiq automatically. This section records how to start them manually and run them in the foreground.

(I have not yet tested the scripts fully, and it's possible Sidekiq may fail if it is run before the manual fixes to the manifest.js file above.)

Solr

Open a new command prompt and vagrant ssh to your box.

cd dur-spotlight
solr_wrapper

Redis

Start a third command prompt and vagrant ssh again. Start the Redis server:

redis-server

Sidekiq

Start a fourth command prompt and vagrant ssh again. Start Sidekiq:

cd dur-spotlight
bundle exec sidekiq