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 destination 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 indexterm:[staff client, installation, Linux]
  49
  50 . On the Evergreen *server*, navigate to the `staff_client` directory inside
  51   the Evergreen source:
  52 +
  53 [source, bash]
  54 --------
  55 cd  /path/to/Evergreen/Open-ILS/xul/staff_client
  56 --------
  57 +
  58 . As the *root* user, build release versions of staff clients for both
  59   32-bit and 64-bit Linux systems:
  60 +
  61 [source, bash]
  62 --------
  63 make rigrelease rebuild linux32-updates-client linux64-updates-client
  64 --------
  65 +
  66 This builds and copies two staff client tarballs for Linux to the `updates`
  67 directory on the Web server.
  68 +
  69 . As the *root* user, reset the ownership of the Evergreen install directory
  70   to the *opensrf* user. For example, if your install directory is `/openils`:
  71 +
  72 [source, bash]
  73 --------
  74 chown -R opensrf:opensrf /openils
  75 --------
  76 +
  77 . On your staff client workstation, download the 32-bit or 64-bit version of
  78   the staff client from your Web server at
  79   http://hostname/updates/manualupdate.html (where _hostname_ represents the
  80   hostname of your Web server).
  81 . On your staff client workstation, create a directory with the name of your
  82   staff client and version.
  83 . Extract the tar files into that directory.
  84 . Within the directory, click on the `evergreen` file to start the program.
  85 +
  86 Or, you can run the program from a terminal (command line). For example, if the
  87 staff client files were extracted to a directory called `evergreen_client` in
  88 your home directory, you can run it with:
  89 +
  90 [source, bash]
  91 --------
  92 ~/evergreen_client/evergreen
  93 --------
  94
  95 Registering a Workstation
  96 ~~~~~~~~~~~~~~~~~~~~~~~~~
  97
  98 anchor:register_workstation[]
  99
 100
 101 indexterm:[staff client, registering a workstation]
 102
 103 Before you can connect to Evergreen from your staff client, you will need to
 104 register your workstation when you try to login.
 105
 106 [NOTE]
 107 ===============
 108 You will need the permissions to add workstations to your network. If you do
 109 not have these permissions, ask your system administrator for assistance.
 110 ===============
 111
 112 . When you login for the first time, a red box will appear around your workstation
 113 information on the right side of the screen.
 114 +
 115 image::media/staff_client_installation_4.png[]
 116 +
 117 . Create a unique workstation name or use the default computer name provided.
 118 . Click _Register_
 119 . You will now be able to log into the system.
 120
 121 Removing Staff Client Preferences
 122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 123
 124
 125 indexterm:[staff client, removing user preferences]
 126 indexterm:[staff client, removing user settings]
 127
 128 Windows
 129 ^^^^^^^
 130
 131 When you uninstall the Evergreen staff client code from your system, the staff
 132 client preferences and cached data are not removed from your system. This can
 133 be a problem if, for example, you have registered your workstation with the
 134 wrong library; or if you have chosen a display language (locale) that is broken
 135 and will not let you start up the client again
 136
 137 On Windows, you can uninstall the Evergreen staff client code using the
 138 Add/Remove Programs menu.
 139
 140 To remove the staff client preferences and cached data entirely on Windows,
 141 there are two directories that you must delete completely (where _<profile>_
 142 represents your user profile name):
 143
 144 * *C:\Documents and Settings\<profile>\Application Data\OpenILS*
 145 * *C:\Documents and Settings\<profile>\Local Settings\Application Data\OpenILS*
 146
 147 You might need to change the preferences in Windows Explorer to display hidden
 148 files (Tools -> Folder Options… -> View).
 149
 150 Linux
 151 ^^^^^
 152
 153 To remove the staff client preferences and cached data from your user account
 154 on Linux, there is one directory that you must delete completely:
 155
 156 [source, bash]
 157 ----------
 158 rm -fr ~/.openils
 159 ----------
 160