Differences

This shows you the differences between two versions of the page.

--- evergreen-user:installing_and_running_the_staff_client [2009/06/08 20:36] – phasefx
+++ evergreen-user:installing_and_running_the_staff_client [2022/02/10 13:34] – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 ====== Installing and Running the Staff Client ======
+NOTE: These instructions are also available in the Evergreen documentation at [[http://docs.evergreen-ils.org/1.6/draft/html/staffclientinstallation.html]]. In github: [[http://github.com/rsoulliere/Evergreen-DocBook/blob/master/1.6/admin/staffclientinstallation.xml]].
 ===== Installing On Windows =====
@@ Line 17: / Line 17: @@
 {{:evergreen-user:staff-client_unconfigured.jpg|}}
-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. \\ \\
+First, configure the server you would like to connect to in the **Server** section. 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.
@@ Line 27: / Line 27: @@
 ===== Installing On Mac =====
-==== Option 1 ====
+==== Evergreen Indiana Pkg file [Evergreen v1.2.3.0] ====
   - Download and install the [[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes|1.8.0.4 Version of XULRunner]] for Mac.  Note, later versions may not work correctly.
   - Download and install the Mac Installation package for the 1_2_3_0 Version Staff Client from [[http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip|HERE]].
@@ Line 35: / Line 35: @@
 When you run the staff client installer, a screen will appear that looks similar to this:
-{{http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif}}
+{{http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif}} **FIXME** Bad Image Link
 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://es.zionsville.lib.in.us/atheos/eg_osx_b.gif}}
+{{http://es.zionsville.lib.in.us/atheos/eg_osx_b.gif}} **FIXME** Bad Image Link
-==== Option 2 ====
+==== Running directly using XULRunner ====
-Follow these next steps if you choose to build the client.
+**Install recommended XULRunner Version**
-XULRunner operates a bit differently under OSX.
+Evergreen 1.2.x.x - [[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes| XULRunner 1.8.0.4]] or [[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.3_Release_Notes| XULRunner 1.8.0.3]]
-The [[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes|Mozilla Developer Center]] contains information that you'll need.
+Evergreen 1.4.x.x - [[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes| XULRunner 1.8.0.4]] or [[http://developer.mozilla.org/en/docs/XULRunner_1.8.0.3_Release_Notes| XULRunner 1.8.0.3]]
-There seems to be issues with the community provided package (currently 1.8.1.3), although ver 1.8.0.4 has been successfully used.
-The staff client data from the ./staff_client/build directory must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client).
+Evergreen 1.6.x.x - [[https://developer.mozilla.org/en/XULRunner| XULRunner 1.9]]
+*Note: If you have issues removing previously installed XULRunner versions see after this entry.
+The staff client data from the ./staff_client/build directory must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client). FIXME Need to clarify "./staff_client/build directory"
 XULRunner must be called via the full path to the binary, followed by the install command and the path to the client data.
@@ Line 59: / Line 62: @@
 A folder named OpenILS under /Applications, with a launcher named open_ils_staff_client, will be created.
+==== Removing previously installed XULRunner versions ====
-If you already have ver. 1.8.1.3 installed, per the 1.8.0.4 release notes, you'll need to remove the entire /Library/Frameworks/XUL.framework directory before reinstalling.  In addition, you may also need to remove the previous xulrunner-ver-mak.pkg file from /Library/Receipts/
+If you already have a newer version installed, per the release notes, you'll need to remove the entire /Library/Frameworks/XUL.framework directory before downgrading.
+In addition, you may also need to remove the previous xulrunner-ver-mak.pkg file from /Library/Receipts/
+If there is no xulrunner-ver-mak.pkg file in /Library/Receipts/ (possibly in newer OSX releases) we need flush receiptdb file.
+*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 > /tmp/pkgs.txt
+</code>
+Since I wanted to purge/forget the build that was initially installed:
+<code bash>
+ sudo pkgutil --forget org.mozilla.xulrunner
+</code>
+http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html
+Note: At first I thought after deleting the folder XUL.framework I had to also edit InstallHistory.plist in /Library/Receipts but that does not seem necessary.
+==== Creating an APP file - Evergreen Staff Client & XULRunner Bundled ====
+  - An app file is basically a folder.  Start with a folder stucture like this:
+  * Evergreen.app
+    * Contents
+      * Frameworks
+      * Resources
+      * MacOS
+eg:
+<code sh>
+  mkdir -p Evergreen.app/Contents/Frameworks
+  mkdir -p Evergreen.app/Contents/Resources
+  mkdir -p Evergreen.app/Contents/MacOS
+</code>
+  - Create a new file in Evergreen.app/Contents/Info.plist with the following (adjust for your version of Evergreen)
+<code xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+        <key>CFBundleExecutable</key>
+        <string>xulrunner</string>
+        <key>CFBundleGetInfoString</key>
+        <string>OpenILS open_ils_staff_client rel_1_6_0_0</string>
+        <key>CFBundleInfoDictionaryVersion</key>
+        <string>6.0</string>
+        <key>CFBundleName</key>
+        <string>Evergreen Staff Client</string>
+        <key>CFBundlePackageType</key>
+        <string>APPL</string>
+        <key>CFBundleShortVersionString</key>
+        <string>rel_1_6_0_0</string>
+        <key>CFBundleVersion</key>
+        <string>rel_1_6_0_0.rel_1_6_0_0</string>
+        <key>NSAppleScriptEnabled</key>
+        <true/>
+	<key>CFBundleTypeIconFile</key>
+        <string>Evergreen.icns</string>
+        <key>CFBundleIdentifier</key>
+        <string>org.evergreen-ils.Evergreen</string>
+</dict>
+</plist>
+</code>
+  - Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (See above for recommendations)
+  - Make a copy of /Library/Frameworks/XUL.Framework inside your app file, it should look something like this:
+    * Evergreen.app/
+      * Contents/
+        * Frameworks/
+          * XUL.Framework/
+            * Versions/
+              * Current -> 1.9.1.3 (symlink)
+              * 1.9.1.3/
+            * XUL -> Versions/Current/XUL
+            * libxpcom.dylib -> Versions/Current/libxpcom.dylib
+            * xulrunner-bin -> Versions/Current/xulrunner-bin
+  - copy XUL.Framework/Versions/Current/xulrunner into Evergreen.app/Contents/MacOS (do not symlink, copy the file)
+  - Make Evergreen.app/Resources the root of your Evergreen application files like this:
+    * 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: [[http://winebottler.kronenberg.org/|http://winebottler.kronenberg.org/]]
+  - open the application "WineBottler"
+  - select "Create Custom Prefixes"
+  - select the desired windows installer as your "Install File"
+  - set the "Runtime arguments" to "build/application.ini"
+  - click "Install" -- you will now see the Evergreen Windows Installer
+  - 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.
+<code>cd ~/ILS/Open-ILS/xul/staff_client
+scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/</code>
+It can be run from the build directory by:
+<code>xulrunner ~/eg-client-x.x.x.x/build/application.ini</code>
 ====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:
@@ Line 107: / Line 218: @@
 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://svn.open-ils.org/trac/ILS.  Look in the "Visit" drop-down box.  You will see a list of Branches and, further down, a list of Tags.  You'll have to do some guesswork, but it's fairly straightforward to determine which tag to use.  If the server is on version 1.2.1.4, you'll want to use the tag that looks most appropriate.  As you look through the tag list, you'll notice a tag named 'rel_1_2_1_4'.  This is the tag you'll want to use; make a note of it, because you'll need the tag name for the next step.
+To determine which tag to use, browse to http://git.evergreen-ils.org/?p=Evergreen.git;a=summary.  The summary page includes a list of tags and branches.  Depending on whether a release was made before or after the project moved to Git, select either the Git tag or the branch converted from an SVN release tag (e.g., tags/rel_1_2_1_4.)
 ==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.  Navigate to the desired directory and use the following command to download the proper version of the source code by tag:
 <code>
-svn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/
+git clone git://git.evergreen-ils.org/Evergreen.git
+git checkout -b tmp_branch origin/rel_1_2_1 # or git checkout rel_1_2_1
 </code>
 Note that you'll want to change "rel_1_2_1_4" to the appropriate tag for your installation.
@@ Line 143: / Line 255: @@
 <code>
-svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/
+git clone git://git.evergreen-ils.org/Evergreen.git
-cd rel_1_4_0_4
+git checkout rel_1_4_0_4
 ./autogen.sh   # If you downloaded a .tar.gz of Evergreen, you may skip this step
 ./configure --prefix=/openils --sysconfdir=/openils/conf
@@ Line 205: / Line 317: @@
 Staff Client", or launch from the desktop shortcut.
+===== 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.  For more details, see [[evergreen-user:configuring_a_proxy_for_the_staff_client]].