docs/installation/staff_client_installation.txt

   1 Installing the Staff Client
   2 ---------------------------
   3
   4 Installing on Windows
   5 ~~~~~~~~~~~~~~~~~~~~~
   6
   7 anchor:installing_staff_client_on_Windows[]
   8
   9 indexterm:[staff client, installation, Windows]
  10
  11 Official Evergreen releases have corresponding Windows based staff clients ready
  12 to use.
  13
  14 . Download the staff client from http://www.open-ils.org/downloads.php.
  15 +
  16 [NOTE]
  17 ===============
  18 The version of your staff client will
  19 need to match the version of your Evergreen server.  If you are unsure about the
  20 version of your Evergreen server, contact your system administrator.
  21 ===============
  22 +
  23 .  Click on the downloaded Evergreen setup file.
  24 . Click _Next_ to begin installation:
  25 +
  26 image::media/staff_client_installation_0.png[]
  27 +
  28 . Click _Next_ to accept
  29 desitnation folder.
  30 +
  31 image::media/staff_client_installation_1.png[]
  32 +
  33 . Click _Install_.
  34 +
  35 image::media/staff_client_installation_2.png[]
  36 +
  37 . A pop-up should appear indicating that Evergreen has been installed.
  38 Click _Finish_ to complete the installation.
  39
  40 image::media/staff_client_installation_3.png[]
  41
  42 When you login to Evergreen from the workstation for the first time,  you will
  43 also need to <<register_workstation,register your workstation>>.
  44
  45 Installing on Linux
  46 ~~~~~~~~~~~~~~~~~~~
  47
  48 Installation instructions for Linux.
  49
  50
  51 indexterm:[staff client, installation, Linux]
  52
  53
  54 Using Wine and the Windows client
  55 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  56
  57
  58 indexterm:[staff client, installation, Wine]
  59
  60 One of th easiest ways to run a staff client on a Linux machine is to use the
  61 Windows client with Wine.
  62
  63 . Install http://www.winehq.org/download/[Wine] on your Linux machine.
  64 . Download the staff client from http://www.open-ils.org/downloads.php.
  65 . Right click on the downloaded file and open with _Wine Windows
  66 Program Loader_.
  67 . Follow the same instructions as you would for
  68 <<installing_staff_client_on_Windows, installing the staff client on windows>>.
  69
  70 Building and Deploying an Evergreen Staff Client on Linux
  71 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  72
  73 indexterm:[staff client, building, Linux]
  74
  75 . From the Evergreen *server*, Navigate to the staff_client directory:
  76 +
  77 [source, bash]
  78 --------
  79 cd  /home/opensrf/Evergreen-ILS-2.3.3/Open-ILS/xul/staff_client
  80 --------
  81 +
  82 . _Make_  a linux staff client
  83 +
  84 [source, bash]
  85 --------
  86 make linux-client
  87 --------
  88 +
  89 This will generate a staff client tarball called
  90 _evergreen_staff_client.tar.bz2_
  91 +
  92 . FTP or SCP the tarball to your staff client
  93 machine.
  94 . From your staff client machine, create a folder with the name of
  95 your staff client and version.
  96 . Extract the tar files into that folder
  97 . Within the folder, click on the _evergreen_ file to start the program.
  98 +
  99 Or, you can run the program from a terminal (command line). For example, if the
 100 evergreen files were extracted to a directory called  evergreen_client_2.3.3 in
 101 your home directory, you can run it with:
 102 +
 103 [source, bash]
 104 --------
 105 ~/evergreen_client_2.3.3/evergreen
 106 --------
 107
 108 Registering a Workstation
 109 ~~~~~~~~~~~~~~~~~~~~~~~~~
 110
 111 anchor:register_workstation[]
 112
 113
 114 indexterm:[staff client, registering a workstation]
 115
 116 Before you can connect to Evergreen from your staff client, you will need to
 117 register your workstation when you try to login.
 118
 119 [NOTE]
 120 ===============
 121 You will need the permissions to add workstations to your network. If you do
 122 not have these permissions, ask your system administrator for assistance.
 123 ===============
 124
 125 . When you login for the first time, a red box will appear around your workstation
 126 information on the right side of the screen.
 127 +
 128 image::media/staff_client_installation_4.png[]
 129 +
 130 . Create a unique workstation name or use the default computer name provided.
 131 . Click _Register_
 132 . You will now be able to log into the system.
 133
 134 Removing Staff Client Preferences
 135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 136
 137
 138 indexterm:[staff client, removing user preferences]
 139 indexterm:[staff client, removing user settings]
 140
 141 Windows
 142 ^^^^^^^
 143
 144 When you uninstall the Evergreen staff client code from your system, the staff
 145 client preferences and cached data are not removed from your system. This can
 146 be a problem if, for example, you have registered your workstation with the
 147 wrong library; or if you have chosen a display language (locale) that is broken
 148 and will not let you start up the client again
 149
 150 On Windows, you can uninstall the Evergreen staff client code using the
 151 Add/Remove Programs menu.
 152
 153 To remove the staff client preferences and cached data entirely on Windows,
 154 there are two directories that you must delete completely (where _<profile>_
 155 represents your user profile name):
 156
 157 * *C:\Documents and Settings\<profile>\Application Data\OpenILS*
 158 * *C:\Documents and Settings\<profile>\Local Settings\Application Data\OpenILS*
 159
 160 You might need to change the preferences in Windows Explorer to display hidden
 161 files (Tools -> Folder Options… -> View).
 162
 163 Linux
 164 ^^^^^
 165
 166 To remove the staff client preferences and cached data from your user account
 167 on Linux, there is one directory that you must delete completely:
 168
 169 [source, bash]
 170 ----------
 171 rm -fr ~/.openils
 172 ----------
 173