From: Steve Sheppard Date: Thu, 23 Dec 2010 21:38:04 +0000 (-0500) Subject: updates to Staff Client Installation to bring into line with a real installation... X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=b4509efea6a53aa57f172625089741ec30775ec2;p=evergreen%2Ftadl.git updates to Staff Client Installation to bring into line with a real installation attempt; --- diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index f1b5d356f2..fdbf8f2a56 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -36,7 +36,7 @@ Running the Staff Client installer - + Click 'Next' to continue through the guided install @@ -50,7 +50,7 @@ Running the Staff Client for the first time - + First, add the name of your Evergreen server to the field @@ -417,7 +417,7 @@ Determine which version is needed For most end-users, a specific version is required to communicate properly with the Evergreen server. Check - with your system admininstrator, IT person, or HelpDesk to + with your system administrator, IT person, or HelpDesk to determine which Staff Client versions are supported. Next, you need to determine which @@ -531,7 +531,12 @@ will now run the Staff Client. You may wish to create a shortcut for the Staff Client. To do so, use the previous command as the target for the shortcut: - DesktopStartMenuK-Menu + + Desktop + StartMenu + K-Menu + + @@ -591,14 +596,22 @@ Windows XP from the drop-down menu, then click 'Apply'. - Launch the Staff Client A new entry for the - Staff Client should now appear somewhere in the All - Applications menu of your Linux desktop. You may also - find a new desktop shortcut for the Staff Client. To launch the - Staff Client, visit the your desktop's All - Applications menu and find the section similar to - WineProgram FilesEvergreen Staff ClientEvergreen Staff Client - or else launch the Staff Client from the new desktop shortcut. + + Launch the Staff Client + A new entry for the Staff Client should now appear + somewhere in the All Applications menu of + your Linux desktop. You may also find a new desktop shortcut for + the Staff Client. To launch the Staff Client, visit the + All Applications menu on your desktop and + find the section similar to + + Wine + Program Files + Evergreen Staff Client + Evergreen Staff Client + , + or else launch the Staff Client from the new desktop shortcut. + @@ -617,9 +630,7 @@ variables that you can pass to make to influence the manual build process: - - <envar>STAFF_CLIENT_BUILD_ID</envar> - + <envar>STAFF_CLIENT_BUILD_ID</envar> During the normal make install Evergreen server-side software build process, the variable defaults to an automatically generated date/time string, but you can also override the value of BUILD_ID. @@ -641,9 +652,7 @@ - - <envar>STAFF_CLIENT_VERSION</envar> - + <envar>STAFF_CLIENT_VERSION</envar> During the normal make install Evergreen server-side software build process, the variable is pulled automatically from a README file in the Evergreen source root. The variable defaults to @@ -672,9 +681,7 @@ - - <envar>STAFF_CLIENT_STAMP_ID</envar> - + <envar>STAFF_CLIENT_STAMP_ID</envar> During the normal make install Evergreen server-side software build process, the variable is generated from STAFF_CLIENT_VERSION. You may want to have multiple versions @@ -892,6 +899,7 @@ make generic-client The output file evergreen_staff_client.xpi will be created. + Packaging a <systemitem class="osname">Windows</systemitem> Client @@ -1194,7 +1202,7 @@ Once you have created the profiles, run XULrunner with the option (in addition to or if - neeeded). Instead of XULrunner opening a new login + needed). Instead of XULrunner opening a new login window on your existing session it will start a new session instead, which can then be logged in to a different server or workstation ID. @@ -1237,7 +1245,7 @@ Example of unconfigured Staff Client - + In order to assign a workstation a name, a user with appropriate @@ -1251,7 +1259,7 @@ Example of configured Staff Client - + Select the library this workstation physically operates in from the drop @@ -1266,7 +1274,7 @@ Example of registered Staff Client - + You are now ready to log into the Staff Client for the first time. Type in @@ -1278,68 +1286,97 @@ staff client running through an SSH tunnel - The Staff Client can use an SSH - tunnel as a SOCKS 5 proxy. - - Configuring a Proxy for the Staff Client - There are several reasons for sending network traffic for the Staff Client through - an SSH proxy: - - - Firewalls may prevent you from reaching the server. This may happen when you - are connecting the Staff Client to a test server that should not be available - generally, or it may be the result of network design priorities other than ease of - use. - - - You may wish to improve security where Staff Client traffic may be - susceptible to network eavesdropping. This is especially true when wireless is - otherwise the best option for connecting a staff machine to the network. - - - - + You can configure the Staff Client to communicate with the Evergreen server over + an SSH tunnel using a SOCKS 5 proxy + server. There are several reasons for sending network traffic for the Staff Client + through an SSH proxy: + + + Firewalls may prevent you from reaching the Evergreen + server. This may happen when you are connecting the Staff + Client to a test server that should not be available + generally, or it may be the result of network design + priorities other than ease of use. + + + You may wish to improve security in situations where + Staff Client traffic may be susceptible to network + eavesdropping. This is especially true when staff machines + connect via wireless links to the network. + + +
Setting Up an <systemitem class="protocal">SSH</systemitem> Tunnel - You will need a server that allows you to log in via SSH and has network access to the Evergreen server - you want to reach. You will use your username and password for that - SSH server to set up a tunnel. - For Windows users, one good solution - is the open-source utility - PuTTY - a free telnet/SSH client. When setting - up a PuTTY session: + You will need a server that allows you to log in via + SSH and has network access to the + Evergreen server you want to reach. You will use your username and password + for that SSH server to set up a + tunnel. + For Windows users, one good + solution is the open-source utility + PuTTY, + a free telnet/SSH client. + Following are instructions for setting up an SSH + session using the PuTTY utility: Setting up an SSH tunnel in PuTTY - + - - Use the menu on the left to go to Connection > SSH > Tunnels. - Enter ''9999'' in the "Source port". - Choose "Dynamic". Do not enter anything in the Destination text entry box. - Click 'Add'; "D9999" will now appear in the "Forwarded - ports" list. - Use the menu on the left to go back to "Session", and enter the host name of the - SSH server. - A window will open up so that you can enter your username and password. Once you - are logged in, the tunnel is open. - + + + Using the menu on the left, find the section + + Connection + SSH + Tunnels + + + + + In the section on the right labeled "Source + port", enter 9999. + + + Set the checkbox "Dynamic". Do not + enter anything in the "Destination" text + entry box. + + + Click 'Add' and notice that + "D9999" now appears in the section + labeled "Forwarded ports". + + + Use the menu on the left, find the + "Session" section, then enter the host name + of the SSH + server. + + + A pop-up window will open to allow you to enter your + username and password. Once you are logged in, the tunnel is + open. + + See How to set up SSH (for the beginner) for information on setting up SSH for other client operating - systems, - - + systems. +
+
Configuring the Staff Client to Use the <systemitem class="protocal">SSH</systemitem> Tunnel - In order to tell the Staff Client that all traffic should be sent through the - SSH tunnel just configured, you must edit the - file C:\Program Files\Evergreen Staff Client\greprefs\all.js. - Search this file for the word socks to find the appropriate section - for the following changes. + In order to tell the Staff Client that all traffic should be sent + through the SSH tunnel just configured, + you must find edit the file all.js, usually located at + C:\Program Files\Evergreen Staff Client\greprefs\all.js + on a Windows system. + Search this file for the word socks to find the appropriate + section for the following changes. The SOCKS section of "all.js" before changes @@ -1350,10 +1387,14 @@ Make the following changes: - Change the value of network.proxy.socks from - "" to localhost. - Change the value of network.proxy.socks_port from - 0 to 9999. + + Change the value of network.proxy.socks + from "" to localhost. + + + Change the value of network.proxy.socks_port + from 0 to 9999. + @@ -1363,10 +1404,58 @@ - If everything is working correctly, you should now be able to run the Staff Client - and all its data will be sent encrypted through the + If everything is working correctly, you should now be able to run + the Staff Client and all its data will be sent encrypted through the SSH tunnel you have just configured. - +
+ +
+ Navigating a Tabbed Interface + Like many popular current web browsers and other applications, the Staff Client + uses a "tabbed" interface. Tabs allow you to have several pages open at the same time + in a single window. This is easier to manage on your computer screen than multiple + windows, since you can easily switch between tabs in the same window. + + + Tabs in the Staff Client window + + + + + + The "tabs" appear below the menu bar in the Staff Client with a descriptive + title. Simply select a tab to bring it to the front and view the page displayed in the + tab. You can use tabs to have access to multiple things all at the same time: patron + records and searches, bibliographic records and searches, circulation or cataloging + interfaces - anything at all in the Staff Client. + + Create a new tab by pressing + + Ctrl + T + + on the keyboard or selecting + + File + New Tab + + from the menu. + Close a tab by pressing + + Ctrl + W + on the keyboard or selecting + + File + Close Tab + + from the menu. + Switch tabs by pressing + + Ctrl + Tab + on the keyboard or selecting the tab in the tab bar. +
diff --git a/1.6/media/staffclientinstallation-tabbed-1.png b/1.6/media/staffclientinstallation-tabbed-1.png new file mode 100644 index 0000000000..15c6e0a86a Binary files /dev/null and b/1.6/media/staffclientinstallation-tabbed-1.png differ