This documentation assumes Windows users will use the Hatch Windows installer. The Linux-only steps can also be done on Windows, but are not documented here.

Install Java

Windows

Windows only requires a JRE to run Hatch, not a full JDK. Download and install JRE version 1.8 or higher from (for example) oracle.com.

Linux

# Debian/Ubuntu version
$ sudo apt-get install openjdk-8-jdk openjfx

Install Hatch

Windows

Execute the Hatch Installer.exe executable.

Note
See installer/windows/README.adoc for building the Windows installer from Linux or Windows. When building the Windows installer on Windows, the full JDK will be required (for compiling Java).

Linux

$ ./hatch.sh compile

Optional: Test Hatch

Note
print commands are disabled by default in the tests to avoid unexpected printing, but they can be added by un-commenting them in src/org/evergreen_ils/hatch/TestHatch.java and recompiling.
$ mkdir -p ~/.evergreen
$ ./hatch.sh test

Install Chrome Extension [Windows & Linux]

  1. Open Chrome/Chromium and navigate to chrome://extensions

  2. Enable "Developer Mode" along the top right of the page.

  3. Click the "Load Unpacked Extension…" button.

  4. Load the directory at Hatch ⇒ extension ⇒ app

    1. In Windows, the default location for the app directory will be C:\Program Files (x86)\Hatch\extension\app

Optional: Debugging The Chrome Extension

  • Click the "Background Page" link to see the exension console.

  • When the extension is loaded (or reloaded), it should show "Connecting to native messaging host: org.evergreen_ils.hatch" in the Background Page console with no errors.

  • Use the "Reload" link to apply local changes made to the extension (e.g. main.js).

  • See also https://developer.chrome.com/extensions/getstarted

Linux: Configure Native Messaging

Edit extension/host/org.evergreen_ils.hatch.json and change the "path" value to match the location of your copy of "hatch.sh", found in the root directory of the Hatch repository.

Copy the host file into Chrome’s configuration directory.

For Chrome:

$ mkdir -p ~/.config/google-chrome/NativeMessagingHosts/
$ cp extension/host/org.evergreen_ils.hatch.json ~/.config/google-chrome/NativeMessagingHosts/

For Chromium:

$ mkdir -p ~/.config/chromium/NativeMessagingHosts/
$ cp extension/host/org.evergreen_ils.hatch.json ~/.config/chromium/NativeMessagingHosts/

Using Hatch

Note
At time of writing, the Evergreen server used must have the patches included in the Hatch 2.12 Omnibus Branch.
  • In Chrome, navigate to the browser staff URL (https://HOSTNAME/eg/staff/).

  • Open the Javascript console. It should show messages like:

Loading Hatch relay content script
...
sending to Hatch: {"key":"eg.workstation.all","action":"get","msgid":1}
...
Hatch responded to message ID 1