1 = Hatch Install Documentation =
3 This documentation assumes Windows users will use the Hatch Windows
4 installer. The xref:linux[Linux]-only steps can also be done on Windows
5 from a source checkout but are not documented here.
11 Execute the 'Hatch-Installer-(version).exe' executable.
13 NOTE: See installer/windows/README.adoc for building the Windows
14 installer from Linux or Windows. When building the Windows installer
15 on Windows a full JDK is required for compiling.
17 ==== Optional: Test Hatch ====
20 -------------------------------------------------------------------------
21 C:\>cd %ProgramFiles(x86)%\Hatch
22 C:\Program Files (x86)\Hatch>hatch.bat test
23 -------------------------------------------------------------------------
25 === Install Chrome Extension ===
27 If the extension was not installed automatically when installing Hatch you can get it directly in the browser from the
28 https://chrome.google.com/webstore/detail/hatch-native-messenger/ppooibdipmklfichpmkcgplfgdplgahl[Chrome App Store].
30 === Install Firefox Extension ===
32 The Firefox extension can not be installed automatically by the native application installer;
33 https://addons.mozilla.org/en-US/firefox/addon/hatch-native-messenger/[it is available on the Firefox Addons site].
35 === Continue with xref:using-hatch[Using Hatch] ===
41 === Download Hatch Sources
44 -----------------------------------------------------------------------------
45 git clone git://git.evergreen-ils.org/Hatch.git
47 -----------------------------------------------------------------------------
49 === Download Java Dependencies
52 -----------------------------------------------------------------------------
54 -----------------------------------------------------------------------------
59 -------------------------------------------------------------------------
61 -------------------------------------------------------------------------
63 === Configure Native Messaging ===
65 Edit extension/host/org.evergreen_ils.hatch.(chrome|firefox).json and change the "path"
66 value to match the location of your copy of "hatch.sh", found in the root
67 directory of the Hatch repository.
69 Copy the correct host file, changing the filename to org.evergreen_ils.hatch.json, into the browser's configuration directory.
74 -------------------------------------------------------------------------
75 $ mkdir -p ~/.config/google-chrome/NativeMessagingHosts/
76 $ cp extension/host/org.evergreen_ils.hatch.chrome.json ~/.config/google-chrome/NativeMessagingHosts/org.evergreen_ils.hatch.json
77 -------------------------------------------------------------------------
82 -------------------------------------------------------------------------
83 $ mkdir -p ~/.config/chromium/NativeMessagingHosts/
84 $ cp extension/host/org.evergreen_ils.hatch.chrome.json ~/.config/chromium/NativeMessagingHosts/org.evergreen_ils.hatch.json
85 -------------------------------------------------------------------------
90 -------------------------------------------------------------------------
91 $ mkdir -p ~/.mozilla/native-messaging-hosts/
92 $ cp extension/host/org.evergreen_ils.hatch.firefox.json ~/.mozilla/native-messaging-hosts/org.evergreen_ils.hatch.json
93 -------------------------------------------------------------------------
95 === Install Chrome Extension ===
97 Install the Chrome exenstion directly from the
98 https://chrome.google.com/webstore/detail/hatch-native-messenger/ppooibdipmklfichpmkcgplfgdplgahl[Chrome App Store].
100 === Install Firefox Extension ===
102 Install the Firefox extension from the
103 https://addons.mozilla.org/en-US/firefox/addon/hatch-native-messenger/[Firefox Addons site].
106 ==== Optional: Test Hatch ====
108 NOTE: print commands are disabled by default in the tests to avoid
109 unexpected printing but they can be added by un-commenting
110 them in src/org/evergreen_ils/hatch/TestHatch.java and recompiling.
113 -------------------------------------------------------------------------
114 $ mkdir -p ~/.evergreen
116 -------------------------------------------------------------------------
118 === Continue with xref:using-hatch[Using Hatch] ===
124 === Download Hatch Sources
127 -----------------------------------------------------------------------------
128 git clone git://git.evergreen-ils.org/Hatch.git
130 -----------------------------------------------------------------------------
132 === Download Java Dependencies
135 -----------------------------------------------------------------------------
137 -----------------------------------------------------------------------------
139 === Compile Hatch ===
142 -------------------------------------------------------------------------
144 -------------------------------------------------------------------------
146 === Configure Native Messaging ===
148 Edit extension/host/org.evergreen_ils.hatch.(chrome|firefox).json and change the "path"
149 value to match the location of your copy of "hatch.sh", found in the root
150 directory of the Hatch repository.
152 Copy the correct host file, changing the filename to org.evergreen_ils.hatch.json, into the browser's configuration directory.
157 -------------------------------------------------------------------------
158 $ mkdir -p ~/Library/Application\ Support/Google/Chrome/NativeMessagingHosts/
159 $ cp extension/host/org.evergreen_ils.hatch.chrome.json ~/Library/Application\ Support/Google/Chrome/NativeMessagingHosts/org.evergreen_ils.hatch.json
160 -------------------------------------------------------------------------
165 -------------------------------------------------------------------------
166 $ mkdir -p ~/Library/Application\ Support/Chromium/NativeMessagingHosts/
167 $ cp extension/host/org.evergreen_ils.hatch.chrome.json ~/Library/Application\ Support/Chromium/NativeMessagingHosts/org.evergreen_ils.hatch.json
168 -------------------------------------------------------------------------
173 -------------------------------------------------------------------------
174 $ mkdir -p ~/Library/Application\ Support/Mozilla/NativeMessagingHosts/
175 $ cp extension/host/org.evergreen_ils.hatch.chrome.json ~/Library/Application\ Support/Mozilla/NativeMessagingHosts/org.evergreen_ils.hatch.json
176 -------------------------------------------------------------------------
178 === Install Chrome Extension ===
180 Install the Chrome exenstion directly from the
181 https://chrome.google.com/webstore/detail/hatch-native-messenger/ppooibdipmklfichpmkcgplfgdplgahl[Chrome App Store].
183 === Install Firefox Extension ===
185 Install the Firefox extension from the
186 https://addons.mozilla.org/en-US/firefox/addon/hatch-native-messenger/[Firefox Addons site].
189 ==== Optional: Test Hatch ====
191 NOTE: print commands are disabled by default in the tests to avoid
192 unexpected printing but they can be added by un-commenting
193 them in src/org/evergreen_ils/hatch/TestHatch.java and recompiling.
196 -------------------------------------------------------------------------
197 $ mkdir -p ~/.evergreen
199 -------------------------------------------------------------------------
205 * In Chrome, navigate to the browser staff URL (https://HOSTNAME/eg/staff/).
206 * Open the Javascript console. It should show messages like:
209 -------------------------------------------------------------------------
210 Loading Hatch relay content script
212 sending to Hatch: {"key":"eg.workstation.all","action":"get","msgid":1}
214 Hatch responded to message ID 1
215 -------------------------------------------------------------------------
217 * Enable Hatch features by navigating to
218 https://HOSTNAME/eg/staff/admin/workstation/hatch.
219 * To determine if Hatch can see your printer(s), navigate to
220 https://HOSTNAME/eg/staff/admin/workstation/print/config
221 ** The "Select Printer" drop-down should show your printer(s).
222 ** The various printer attribute selectors should show values supported
223 by the selected printer.
225 === Optional: Debugging The Chrome Extension ===
227 * Navigate to chrome://extensions
228 * Enable "Developer Mode" along the top right of the page.
229 * Click the "Background Page" link to see the exension console.
230 * When the extension is loaded (or reloaded), it should show
231 "Connecting to native messaging host: org.evergreen_ils.hatch"
232 in the Background Page console with no errors.
233 * Use the "Reload" link to apply local changes made to the
234 extension (e.g. extension.js). (This might only work when installing
235 the exention manually via developer mode tools).
236 * See also https://developer.chrome.com/extensions/getstarted