evergreen-user:installing_and_running_the_staff_client
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
evergreen-user:installing_and_running_the_staff_client [2011/01/04 13:09] – jamesrf | evergreen-user:installing_and_running_the_staff_client [2023/03/07 09:52] (current) – Delete this page dyrcona | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | **[[evergreen-user: | ||
- | [[user-comments: | ||
- | |||
- | ====== Installing and Running the Staff Client ====== | ||
- | NOTE: These instructions are also available in the Evergreen documentation at [[http:// | ||
- | |||
- | ===== Installing On Windows ===== | ||
- | |||
- | The staff client is available for download from the downloads section on the Open-ILS website at http:// | ||
- | |||
- | {{: | ||
- | |||
- | Click the Next button to continue through the guided install process. The install wizard will ask you to agree to the end-user license, ask you where to install the software, ask about where to place icons, and then will install the software on your workstation. | ||
- | |||
- | When you run the staff client for the first time, a screen similar to this will appear: | ||
- | |||
- | {{: | ||
- | |||
- | First, configure the server you would like to connect to in the **Server** section. For example, the PINES demo system is **demo.gapines.org**. After selecting a server, click the **Re-Test Server** button. \\ \\ | ||
- | |||
- | Because this is the initial run of the staff client, the **Workstation** section in the upper-right states: **Not yet configured for the specified server**. The first thing that must be done to every workstation is to assign it a workstation name. This is covered in the [[Workstation Names]] section of the documentation. | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ===== Installing On Mac ===== | ||
- | |||
- | ==== Evergreen Indiana Pkg file [Evergreen v1.2.3.0] ==== | ||
- | - Download and install the [[http:// | ||
- | - Download and install the Mac Installation package for the 1_2_3_0 Version Staff Client from [[http:// | ||
- | - To upgrade to a more recent version of the staff client, you can copy the " | ||
- | - Drag the application' | ||
- | |||
- | When you run the staff client installer, a screen will appear that looks similar to this: | ||
- | |||
- | {{http:// | ||
- | |||
- | Click continue, accept the license, then finish the installation. The application will be located at the destination you selected during installation. You will then be able to drag the application into your toolbar for easier access. | ||
- | |||
- | {{http:// | ||
- | |||
- | ==== Running directly using XULRunner ==== | ||
- | |||
- | **Install recommended XULRunner Version** | ||
- | |||
- | Evergreen 1.2.x.x - [[http:// | ||
- | |||
- | Evergreen 1.4.x.x - [[http:// | ||
- | |||
- | Evergreen 1.6.x.x - [[https:// | ||
- | |||
- | *Note: If you have issues removing previously installed XULRunner versions see after this entry. | ||
- | |||
- | The staff client data from the ./ | ||
- | |||
- | XULRunner must be called via the full path to the binary, followed by the install command and the path to the client data. | ||
- | / | ||
- | |||
- | This command should exit quietly. | ||
- | |||
- | A folder named OpenILS under / | ||
- | |||
- | ==== Removing previously installed XULRunner versions ==== | ||
- | |||
- | If you already have a newer version installed, per the release notes, you'll need to remove the entire / | ||
- | |||
- | In addition, you may also need to remove the previous xulrunner-ver-mak.pkg file from / | ||
- | |||
- | If there is no xulrunner-ver-mak.pkg file in / | ||
- | |||
- | *Note: If we install a newer version over a previous (older) install the older one is not removed but the symlinks get changed to the newer one. | ||
- | |||
- | **Flush Receiptdb file:** | ||
- | |||
- | First we get the package identifier: | ||
- | <code bash> | ||
- | sudo pkgutil --pkgs > / | ||
- | </ | ||
- | Since I wanted to purge/ | ||
- | <code bash> | ||
- | sudo pkgutil --forget org.mozilla.xulrunner | ||
- | </ | ||
- | http:// | ||
- | |||
- | Note: At first I thought after deleting the folder XUL.framework I had to also edit InstallHistory.plist in / | ||
- | |||
- | ==== Creating an APP file - Evergreen Staff Client & XULRunner Bundled ==== | ||
- | |||
- | - An app file is basically a folder. | ||
- | * Evergreen.app | ||
- | * Contents | ||
- | * Frameworks | ||
- | * Resources | ||
- | * MacOS | ||
- | eg: | ||
- | <code sh> | ||
- | mkdir -p Evergreen.app/ | ||
- | mkdir -p Evergreen.app/ | ||
- | mkdir -p Evergreen.app/ | ||
- | </ | ||
- | |||
- | - Create a new file in Evergreen.app/ | ||
- | <code xml> | ||
- | <?xml version=" | ||
- | < | ||
- | <plist version=" | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | < | ||
- | </ | ||
- | </ | ||
- | </ | ||
- | |||
- | - Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (See above for recommendations) | ||
- | - Make a copy of / | ||
- | * Evergreen.app/ | ||
- | * Contents/ | ||
- | * Frameworks/ | ||
- | * XUL.Framework/ | ||
- | * Versions/ | ||
- | * Current -> 1.9.1.3 (symlink) | ||
- | * 1.9.1.3/ | ||
- | * XUL -> Versions/ | ||
- | * libxpcom.dylib -> Versions/ | ||
- | * xulrunner-bin -> Versions/ | ||
- | - copy XUL.Framework/ | ||
- | - Make Evergreen.app/ | ||
- | * Evergreen.app/ | ||
- | * Contents/ | ||
- | * Resources/ | ||
- | * BUILD_ID | ||
- | * application.ini | ||
- | * chrome/ | ||
- | * components/ | ||
- | * etc. | ||
- | - Put a Mac format icon file named Evergreen.icns in Resources | ||
- | |||
- | ==== WineBottler ==== | ||
- | |||
- | - download and install WineBottler: | ||
- | - open the application " | ||
- | - select " | ||
- | - select the desired windows installer as your " | ||
- | - set the " | ||
- | - click " | ||
- | - when you get to the end **UNCHECK** the option to "run Evergreen now" and complete the installation | ||
- | - WineBottler should then pop up a dialog for you to select an executable -- select xulrunner.exe | ||
- | |||
- | |||
- | ===== Installing On Linux ===== | ||
- | ====Quick Upgrade of the Staff Client==== | ||
- | A Linux staff client is built on the server as part of the initial installation of Evergreen. | ||
- | To upgrade the client copy the folder containing the new client on to your workstation from the server. | ||
- | < | ||
- | scp -r build user@client.linux.machine: | ||
- | |||
- | It can be run from the build directory by: | ||
- | < | ||
- | |||
- | ====Building the Staff Client on the Server==== | ||
- | A Linux staff client is built on the server as part of the initial installation of Evergreen, using the following steps: | ||
- | < | ||
- | make STAFF_CLIENT_BUILD_ID=' | ||
- | mkdir / | ||
- | mkdir / | ||
- | cd build/ | ||
- | cp -R server/ / | ||
- | |||
- | It can be run from the build directory by: | ||
- | < | ||
- | |||
- | In order to install a compatible staff client on another Linux machine, you can copy the applicable files from the server to that Linux machine, or even build it from scratch on that machine. | ||
- | |||
- | If you will be using a pre-packaged Windows version on some computers as well, you may want to choose your Build ID on both server and other versions to match that of the Windows staff client. | ||
- | |||
- | An alternative option if you have access to make changes to the Evergreen server is to create a symbolic link. In order for a copy of the staff client and server to work together, the Build ID (shown when you click "About this Client" | ||
- | |||
- | < | ||
- | sudo ln -s server_build_id/ | ||
- | |||
- | |||
- | ====Building the Staff Client on a Client Machine==== | ||
- | This section is more toward an end-user who may wish to use Linux rather than Windows for client machines, but has limited Linux experience. | ||
- | The Staff Client can be built on Linux without installing the Evergreen Server component; this is a relatively simple process, compared to server installation, | ||
- | |||
- | ===1: Prerequisites=== | ||
- | * subversion client | ||
- | * xulrunner | ||
- | Using apt-get to acquire these: | ||
- | < | ||
- | sudo apt-get install subversion | ||
- | sudo apt-get install xulrunner | ||
- | </ | ||
- | Synaptic can also be used; search for subversion and select the latest version, and search for xulrunner and select version 1.8.1.4-2ubuntu5. | ||
- | ===2: Download the Source Code=== | ||
- | ==2a: Determine which version is needed.== | ||
- | For most end-users, a specific version is required to communicate properly with the Evergreen server. | ||
- | |||
- | Next, you'll need to determine which //tag// to use when downloading the source code. Tags are markers in the source code to create a snapshot of the code as it existed at a certain time; tags usually point to tested and stable code, or at least a community-recognized release version. | ||
- | |||
- | To determine which tag to use, browse to http:// | ||
- | |||
- | |||
- | ==2b: Download the Source Code.== | ||
- | Now, open a terminal (command-line prompt) and navigate to the directory in which you wish to download the staff client. | ||
- | < | ||
- | svn co svn:// | ||
- | </ | ||
- | Note that you'll want to change " | ||
- | ===3: Build the Staff Client.=== | ||
- | |||
- | ==Evergreen 1.2.x== | ||
- | |||
- | From the command line, navigate to the directory in which you downloaded the source code. Then, navigate to the proper subdirectory: | ||
- | < | ||
- | Now, we'll run the " | ||
- | < | ||
- | |||
- | ==Evergreen 1.4.x== | ||
- | |||
- | The 1.4 series of Evergreen has complicated the build process for staff clients a bit. If you downloaded a .tar.gz (tarball) of Evergreen, then your steps will resemble: | ||
- | |||
- | FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF. | ||
- | |||
- | < | ||
- | wget http:// | ||
- | tar xfz Evergreen-ILS-1.4.0.4.tar.gz | ||
- | cd Evergreen-ILS-1.4.0.4/ | ||
- | ./configure --prefix=/ | ||
- | cd Open-ILS/ | ||
- | make STAFF_CLIENT_BUILD_ID=' | ||
- | </ | ||
- | |||
- | If you're installing from a Subversion checkout: | ||
- | |||
- | < | ||
- | svn co svn:// | ||
- | cd rel_1_4_0_4 | ||
- | ./ | ||
- | ./configure --prefix=/ | ||
- | cd Open-ILS/ | ||
- | make STAFF_CLIENT_BUILD_ID=' | ||
- | </ | ||
- | |||
- | |||
- | ===4: Run the Staff Client (from the command line).=== | ||
- | Navigate to the ' | ||
- | < | ||
- | Make sure you run this from ' | ||
- | ===5: Cleaning Up/Creating Shortcuts (Optional)=== | ||
- | The source code download included many files that are needed to build the Staff Client, but not necessary to run it. You may wish to remove them to save space, or to create a directory containing the built staff client that can be copied to other machines.\ | ||
- | To do this, first create the directory where you wish to place your ' | ||
- | < | ||
- | Then, copy the ' | ||
- | < | ||
- | cp -r staff_client ~/< | ||
- | </ | ||
- | Test to verify that all the necessary files were moved to the destination directory: | ||
- | < | ||
- | cd ~/< | ||
- | xulrunner application.ini | ||
- | </ | ||
- | The Staff Client should run properly. | ||
- | < | ||
- | |||
- | Almost done! Now, the command < | ||
- | |||
- | |||
- | ==== Using Wine to Install On Linux ==== | ||
- | Wine is also an alternative for those who want to install the packaged Windows versions rather than building the Staff Client manually. | ||
- | |||
- | 1: Install Wine (using apt-get): | ||
- | |||
- | | ||
- | |||
- | Here is more information about installing Wine: | ||
- | http:// | ||
- | |||
- | |||
- | 2) Download the proper EG Staff Client installer from the | ||
- | open-ils.org website and put it in a directory you like: | ||
- | |||
- | < | ||
- | command-prompt: | ||
- | </ | ||
- | 3) In the GUI, navigate to the file where you downloaded the | ||
- | setup file and run it; this will install the SC. If this fails, | ||
- | you may need to configure Wine first to emulate Windows XP. | ||
- | |||
- | To do so, type " | ||
- | " | ||
- | Settings" | ||
- | click " | ||
- | |||
- | 4) To launch the Evergreen Staff Client, go to the All Applications menu, | ||
- | select " | ||
- | Staff Client", | ||
- | |||
- | ===== Running the Staff Client with an SSH Tunnel as a SOCKS 5 Proxy ===== | ||
- | |||
- | The Evergreen Staff Client can use an SSH tunnel as a SOCKS 5 proxy. | ||
evergreen-user/installing_and_running_the_staff_client.1294164576.txt.gz · Last modified: 2022/02/10 13:33 (external edit)