Setting up your environment - Part 2 - GeoBlacklight Workshop
Feb 9, 2015
Setting up your environment
- Development requirements
- Local attendees setup VirtualBox/Vagrant
Development requirements
GeoBlacklight has similar prerequisites to Blacklight. It diverges from Blacklight requirements by using a customized Solr schema and configuration, Geoblacklight Schema, Version 1.0.
Software you should have installed on your development computer
- Ruby > 2.6.6
- Rails > 6.0
- Git
- Java > 1.8 (Download JDK for local Solr server)
- Node.js > 14.15 LTS
- Yarn > 1.13
It is recommended to install the latest versions of Ruby, Rails, and Node.js. We strive to keep GeoBlacklight updated with these versions. A great, almost always up-to-date, tutorial on getting a Ruby on Rails development environment is available here: https://gorails.com/setup. If you are not following this tutorial as part of an in person workshop, you can skip to the next section once you have these dependencies installed.
Local attendees of the workshop have the option of just using the pre-created environment on the provided thumb-drive. Note: You can complete this tutorial without Vagrant as long as you already have the above mentioned software on your machine. If you do, you may skip ahead to Part 3 - Create your application
Also, if you are not at the workshop (or perhaps if you want to prepare your own environment for a workshop you are facilitating), you can create the virtual machine for the workshop, by following this guide.
In-person attendees setup VirtualBox/Vagrant
Good news for in-person workshop participants: the process of setting up your environment has already done for you using VirtualBox and Vagrant. On the thumb-drive underneath a directory titled ‘geoblacklight_workshop’. Thanks to Justin Coyne and Data Curation Experts for this approach that is used at HydraCamps.
For those interested in what was installed on this machine and how it was created checkout this gist.
Vagrant Quick Tips
After you have your virtual machine up and going, you will want to stop it. Here are a few commands that will help out.
$ vagrant halt # stops the virtual machine
$ vagrant destroy # stops and deletes the virtual machine
Vagrant for OS X and Linux
-
Install the Mac (.dmg) version of VirtualBox and Vagrant on your machine. If you are using Linux, please download and install appropriately. VirtualBox Downloads, Vagrant Downloads
-
If not already on your Desktop, copy the
geoblacklight_workshop
directory to your~/Desktop
directory -
Move to your
~/Desktop/geoblacklight_workshop
directory$ cd ~/Desktop/geoblacklight_workshop
-
Start vagrant
$ vagrant up # This command creates and configures guest machines according to your Vagrantfile.
-
SSH to the VM
$ vagrant ssh # This will SSH into a running Vagrant machine and give you access to a shell.
Vagrant for Windows
Thanks to Zach Vowell who contributed this guide for Windows.
Note: Please install a Windows ssh client installed such as PuTTY.
-
Install the Windows (.exe) version of VirtualBox and Vagrant on your machine.
-
If not already on your Desktop, copy the
geoblacklight_workshop
directory to your DesktopC:\Users\[username]\Desktop
(for Windows 7) -
Open a Windows Command Prompt (cmd)
-
Move to the
geoblacklight_workshop
directory on the DesktopC:\Users\[username]> cd Desktop\geoblacklight_workshop
-
Start Vagrant
C:\Users\[username]\Desktop\geoblacklight_workshop> vagrant up # This command creates and configures guest machines according to your Vagrantfile.
-
Open up PuTTY
-
SSH into the Vagrant box by entering the following parameters into the “Basic Options for Your PuTTY session” window: - Host Name (or IP address): 127.0.0.1 - Port: 2222
-
When PuTTY shell prompts for a username and password, enter “vagrant” for both. You should now see a command prompt.
- Introduction
- Part 1 - GeoBlacklight overview
- Part 2 - Setting up your environment
- Part 3 - Create your application
- Part 4 - Index Solr documents
- Part 5 - Customize your application