installer/windows/README.adoc

   1 [[hatch---java-print-storage-etc-service]]
   2 Hatch - Java Print / Storage / Etc Service
   3 ------------------------------------------
   4
   5 [[hatch-download-sources]]
   6 Hatch Download sources
   7 ^^^^^^^^^^^^^^^^^^^^^^
   8
   9 http://git.evergreen-ils.org/?p=working/Hatch.git;a=summary
  10
  11 [[requirements]]
  12 Requirements
  13 ~~~~~~~~~~~~
  14
  15 1.  NSIS
  16 3.  JDK or OpenJDK v. 1.8 or higher
  17
  18 [[pre-installation]]
  19 Pre-Installation
  20 ~~~~~~~~~~~~~~~~
  21
  22 [[compiling-hatch]]
  23 Compiling Hatch
  24 ^^^^^^^^^^^^^^^
  25
  26 Before installing, Hatch will need to be properly compiled.
  27
  28 Windows:
  29 ++++++++
  30
  31 ....
  32 C:\> hatch.bat compile
  33 ....
  34
  35 Linux:
  36 ++++++
  37
  38 ....
  39 $ ./hatch.sh compile
  40 ....
  41
  42 More detail on this process and testing it can be found in
  43 INSTALL.adoc.
  44
  45
  46 [[adding-contact-information]]
  47 Adding Contact Information
  48 ^^^^^^^^^^^^^^^^^^^^^^^^^^
  49
  50 Contact Information will be found when a user views the Add/Remove
  51 Programs tool in Windows in order to uninstall or view the information
  52 of an installed program. This information usually consists of an Email,
  53 a URL for updates, and a URL for a description of the program. To set
  54 these, you’ll have to edit defines.nsh, and edit the following fields:
  55
  56 ....
  57 !define HELPURL "mailto:[your@email.here]"
  58 !define UPDATEURL "http://..."
  59 !define ABOUTURL "http://..."
  60 ....
  61
  62 [[updating-version-number]]
  63 Updating Version Number
  64 ^^^^^^^^^^^^^^^^^^^^^^^
  65
  66 As with above, there may be times you want Hatch to install with a new
  67 version number. In Defines.nsh, edit the following fields:
  68
  69 ....
  70 !define VERSIONMAJOR 2
  71 !define VERSIONMINOR 0
  72 !define VERSIONBUILD 0
  73 ....
  74
  75 [[compile-installer]]
  76 Compile Installer
  77 ^^^^^^^^^^^^^^^^^
  78
  79 [[windows]]
  80 Windows:
  81 ++++++++
  82
  83 1.  Right click hatch.nsi -> Compile NSIS Script
  84 2.  Run the generated installer
  85
  86 [[linux]]
  87 Linux:
  88 ++++++
  89
  90 1.  Install NSIS if not already present on your system.
  91 +
  92 ....
  93 sudo apt-get install nsis
  94 ....
  95
  96 2.  Navigate to the hatch repo and compile the installer
  97 +
  98 ....
  99 cd ~/Hatch
 100 makensis installer/windows/hatch.nsi
 101 ....
 102
 103 [[running-hatch]]
 104 Running Hatch
 105 ~~~~~~~~~~~~~
 106
 107 1.  Once installed, open Chrome and navigate to chrome://extensions
 108 2.  Ensure Developer Mode is ticked, and select ``Load Unpacked
 109 Extensions''
 110 3.  Select [Installation Directory]/extension/app/.
 111 4.  In Chrome, navigate to the browser staff URL
 112 (https://HOSTNAME/eg/staff/).
 113 5.  Chrome should display a browser action icon along the top right of
 114 the +
 115 browser window (just left of the settings menu) with a letter ``H''. +
 116 ** TODO: we can apply an icon of our choosing here during the install.
 117 6.  Clicking the ``H'' button should produce a security prompt, click
 118 through +
 119 to allow the requested permissions.
 120 7.  Reload the browser client login page.
 121 8.  Open the Javascript console. It should show messages like:
 122
 123 ....
 124 Loading Hatch relay content script
 125 ...
 126 sending to Hatch: {"key":"eg.workstation.all","action":"get","msgid":1}
 127 Hatch responded to message ID 1
 128 ....
 129
 130 1.  See if Hatch is able to communicate with your printer… Navigate to +
 131 https://HOSTNAME/eg/staff/admin/workstation/print/config
 132 2.  The ``Select Printer'' drop-down should show your printer(s).
 133 3.  The various printer attribute selectors should show values
 134 supported +
 135 by the selected printer.