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