From: Steve Sheppard Date: Mon, 3 Jan 2011 20:50:58 +0000 (-0500) Subject: tweak sections; update the 'Post-Installation Chores' section; update the... X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=530ef8dabca2962e6cc47656e2ff8036eb370e7d;p=contrib%2FConifer.git tweak sections; update the 'Post-Installation Chores' section; update the 'Testing Staff Client' section; --- diff --git a/1.6/admin/serversideinstallation.xml b/1.6/admin/serversideinstallation.xml index a76582ec13..94d612f772 100644 --- a/1.6/admin/serversideinstallation.xml +++ b/1.6/admin/serversideinstallation.xml @@ -928,30 +928,15 @@ yourself, either on the same system as Evergreen itself or on another system. If your PostgreSQL server is on a different system, just skip this step. If your PostgreSQL server will be on the same system as your Evergreen - software, then install the required PostgreSQL server packages as follows. - For further information on manually installing PostgreSQL, visit the official - PostgreSQL Site. - For Debian Lenny and - Ubuntu Hardy (8.04), execute these commands: - - - # as the root user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83 - - For Ubuntu Karmic (9.10) and - Ubuntu Lucid (10.04), execute these commands: - - - # as the root user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84 - + software, you can install the required PostgreSQL server packages as described + in , or you can visit the official + web site http://www.postgresql.org + for more information. PostgreSQL versions 8.3 or 8.4 are the recommended versions to work with Evergreen 1.6.1.2 . If you have an older version of PostgreSQL, you - should upgrade before installing Evergreen. To find the running version of - PostgreSQL, as the postgres + should upgrade before installing Evergreen. To find your current version + of PostgreSQL, as the postgres user execute the command psql, then type SELECT version(); to get detailed information about your version of PostgreSQL. @@ -1514,7 +1499,7 @@ You can load translations such as Armenian (hy-AM), Canadian French (fr-CA), and others into the database to complete the translations available in the OPAC and Staff Client. For further information, see - . + . @@ -1713,7 +1698,7 @@ # as the root user: xulrunner /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build/application.ini - The login screen for the Staff Client should appear: + A login screen for the Staff Client similar to this should appear: Logging into the Staff Client @@ -1811,16 +1796,18 @@
Configure a permanent SSL key - In a previous step (see ) - you used the command openssl to temporarily - create a new SSL key for the Apache server. This self-signed security certificate was adequate - during testing and development, but will continue to generate warnings in the Staff Client - and browser. For a public production server you should configure or purchase a signed SSL - certificate. - There are several open source software solutions that provide schemes to generate and - maintain public key security certificates for your library system. Some popular projects are - listed below; please review them for background information on why you need such a system and - how you can provide it: + You used the command openssl in an earlier step to + temporarily create a new SSL key for the Apache server (see + for further + information). This self-signed security certificate was adequate during + testing and development, but will continue to generate warnings in the Staff + Client and browser. For a public production server you should configure or + purchase a signed SSL certificate. + There are several open source software solutions that provide schemes to + generate and maintain public key security certificates for your library + system. Some popular projects are listed below; please review them for + background information on why you need such a system and how you can provide + it: http://www.openca.org/projects/openca/ @@ -1843,58 +1830,8 @@
(OPTIONAL) Set Up Support For Reports Evergreen reports are extremely powerful but require some simple configuration. - This section describes starting and stopping the Reporter daemon processes. - - - Starting the Reporter Daemon - Once the open-ils.reporter - process is running and enabled on the gateway, you can start the - Reporter daemon. That process periodically checks for requests for new - or scheduled reports, then starts them as required. - As the opensrf user, - start the Reporter daemon using the following command: - - - # as the opensrf user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/src/reporter - ./clark-kent.pl --daemon - - You can control how the clark-kent.pl utility behaves - by specifying any of several command-line options: - - : number of seconds - to sleep between checks for new reports to run; defaults to - 10 - : where to place - the lockfile for the process; defaults to - /tmp/reporter-LOCK - : number of - Reporter daemon processes to run; defaults to - 1 - : OpenSRF - bootstrap configuration file; defaults to - /openils/conf/opensrf_core.xml - - - - Stopping the Reporter Daemon - To stop the Reporter daemon, you must kill the process and remove - the lockfile. The daemon may have just a single associated process or - there may be several processes if the daemon was started with the optional - --concurrency switch. It will also have a lockfile - in the default location. - As the opensrf user, - execute the following shell commands: - - - # as the root user: - # find and kill the process ID number(s) - kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` - # remove the lock file - rm /tmp/reporter-LOCK - - - + See for information on starting and + stopping the Reporter daemon processes.
diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index 8a11420dda..1d88330b5c 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -156,9 +156,9 @@ Evergreen / <application>XULrunner</application> Dependencies - - - + + + Evergreen Version @@ -191,11 +191,11 @@ ~/Desktop/Evergreen_Staff_Client). Remember to call XULrunner with the full path to the binary, followed by the install command and the path to the client data: - - + + /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client - + The command should exit quietly and will create the folder /Applications/OpenILS, containing a launcher named open_ils_staff_client. @@ -224,12 +224,12 @@ (OPTIONAL) Flush Receiptdb file: First, get the package identifier, then purge/forget the build that was initially installed: - - + + sudo pkgutil --pkgs > /tmp/pkgs.txt sudo pkgutil --forget org.mozilla.xulrunner - + It may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder XUL.framework. See @@ -240,23 +240,23 @@ Creating an APP file: Staff Client and <application>XULrunner</application> Bundled An APP file is basically a folder. Start with a folder stucture like this: - - + + Evergreen.app __Contents ____Frameworks ____Resources ____MacOS - + Create an APP folder structure with the following commands: - - + + mkdir -p Evergreen.app/Contents/Frameworks mkdir -p Evergreen.app/Contents/Resources mkdir -p Evergreen.app/Contents/MacOS - + Create a new file in the folder @@ -300,8 +300,8 @@ Make a copy of the folder /Library/Frameworks/XUL.Framework inside your APP file. It should look something like this: - - + + Evergreen.app/ __Contents/ ____Frameworks/ @@ -313,7 +313,7 @@ ______libxpcom.dylib -> Versions/Current/libxpcom.dylib ______xulrunner-bin -> Versions/Current/xulrunner-bin - + Copy XUL.Framework/Versions/Current/xulrunner into the @@ -322,8 +322,8 @@ Make Evergreen.app/Resources the root of your Evergreen application files like this: - - + + Evergreen.app/ __Contents/ ____Resources/ @@ -333,7 +333,7 @@ ______components/ ______etc. - + Put a Mac format icon file named Evergreen.icns in @@ -353,19 +353,19 @@ Execute the following commands, replacing USER, WORKSTATION, and SOME_PATH with appropriate values: - - + + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client scp -r ./build USER@WORKSTATION:/SOME_PATH/ - + You should test the newly copied Staff Client on the remote workstation. Log into the workstation and execute the following command: - - + + xulrunner /SOME_PATH/build/application.ini - + Building the Staff Client on the Server @@ -396,13 +396,13 @@ directory containing the server components of the Staff Client, or the name of a symbolic link to that directory. As the root user, make the changes as follows: - - + + # as the root user: cd /openils/var/web/xul ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID - + Building the Staff Client on a Client Machine @@ -429,13 +429,13 @@ apt-get. For subversion, select the latest version; for XULrunner, select version 1.8.1.4-2ubuntu5. - - + + # as the root user: sudo apt-get install subversion sudo apt-get install xulrunner - + Download the Source Code @@ -474,13 +474,13 @@ to the directory in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag name: - - + + # as the opensrf user: cd /DOWNLOAD/DIRECTORY svn co rel_1_6_1_2/ - + Remember to change "rel_1_6_1_2" to the appropriate tag for your installation. @@ -501,8 +501,8 @@ commands accordingly. As the opensrf user, run the following commands to build the Staff Client: - - + + # as the opensrf user: wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz tar xfz Evergreen-ILS-1.6.1.2.tar.gz @@ -511,20 +511,20 @@ cd ./Open-ILS/xul/staff_client/ make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install - + Run the Staff Client As the opensrf user, navigate to the build/ subdirectory and run the following command: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build xulrunner application.ini - + (OPTIONAL) Clean Up / Create Shortcuts @@ -537,45 +537,42 @@ to replace DOWNLOAD_DIRECTORY and STAGING_DIRECTORY with the appropriate paths): - - + + # as the opensrf user: mkdir ~/STAGING_DIRECTORY cd ~/DOWNLOAD_DIRECTORY/Open-ILS/xul/ cp -r staff_client ~/STAGING_DIRECTORY - + Test the Staff Client to verify that all necessary files were copied to the staging directory: - - + + # as the opensrf user: cd ~/STAGING_DIRECTORY/staff_client/build xulrunner application.ini - + If there were no problems, then finish the cleanup by removing the original download directory as shown: - - + + # as the opensrf user: rm -r -f ~/DOWNLOAD_DIRECTORY - + Finally, the command: - - + + # as the opensrf user: xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini - + 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: - Desktop - StartMenu - K-Menu - + DesktopStartMenuK-Menu @@ -601,12 +598,12 @@ Install wine: - - + + # as the root user: sudo apt-get install wine - + Visit the downloads section of the Evergreen website at @@ -623,13 +620,13 @@ file, then execute it with the wine application (remember to replace VERSION with the release number of the Staff Client you downloaded): - - + + # as the opensrf user: cd /TEMP_DIRECTORY wine evergreen-setup-rel_VERSION.exe - + If this step fails, you may need to configure Wine first to properly emulate Windows XP. To do so, @@ -647,13 +644,7 @@ 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 - , + WineProgram FilesEvergreen Staff ClientEvergreen Staff Client, or else launch the Staff Client from the new desktop shortcut. @@ -676,36 +667,34 @@ process: - Build Variable <envar>STAFF_CLIENT_BUILD_ID</envar> - + Build Variable STAFF_CLIENT_BUILD_ID 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. You could use the following commands during the normal install process: - - + + # as the root user: cd /home/opensrf/Evergreen-ILS-1.6.1.2 make STAFF_CLIENT_BUILD_ID=1_6_1_2 install - + You can also manually build the Staff Client in the Staff Client source directory with a different BUILD_ID. As the opensrf user, execute the following commands to build the Staff Client (remember to replace NEW_VERSION with an appropriate value): - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make STAFF_CLIENT_BUILD_ID=NEW_VERSION build - + - Build Variable <envar>STAFF_CLIENT_VERSION</envar> - + Build Variable STAFF_CLIENT_VERSION 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 @@ -713,13 +702,13 @@ automatically generated. You can override the value of VERSION similarly to the BUILD_ID. You could use the following commands during the normal install process: - - + + # as the root user: cd /home/opensrf/Evergreen-ILS-1.6.1.2 make STAFF_CLIENT_VERSION=0mytest.200 install - + You can also manually build the Staff Client in the Staff Client source directory with a different VERSION. If you plan to make extensions update automatically, the @@ -729,18 +718,17 @@ versions. As the opensrf user, execute the following commands to build the Staff Client: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make STAFF_CLIENT_VERSION=0mytest.200 build - + - Build Variable <envar>STAFF_CLIENT_STAMP_ID</envar> - + Build Variable STAFF_CLIENT_STAMP_ID 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 @@ -748,24 +736,24 @@ client-side customizations. You can override the value of STAMP_ID similarly to the BUILD_ID. You could use the following commands during the normal install process: - - + + # as the root user: cd /home/opensrf/Evergreen-ILS-1.6.1.2 make STAFF_CLIENT_STAMP_ID=my_test_stamp install - + You can also manually build the Staff Client in the Staff Client source directory with a different STAMP_ID. As the opensrf user, execute the following commands to build the Staff Client: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make STAFF_CLIENT_STAMP_ID=my_test_stamp build - +
@@ -784,8 +772,8 @@ Keywords Targets for "make" Command - - + +
Keyword @@ -867,13 +855,13 @@ extra configuration file that enables some developer options. As the opensrf user, run the following commands from the Staff Client source directory: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make devbuild - + Compressed Javascript @@ -886,50 +874,50 @@ http://code.google.com/closure/compiler. As the opensrf user, run the following commands from the Staff Client source directory: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make compress-javascript - + You can also combine Javascript review and compression, and also perform a developer build. As the opensrf user, run the following make command from the Staff Client source directory (the order of options is important): - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make devbuild compress-javascript - + Automatic Update Host You can override the host used to check for automatic Staff Client updates by specifying the option. You could use the following commands during the normal install process: - - + + # as the root user: cd /home/opensrf/Evergreen-ILS-1.6.1.2 make AUTOUPDATE_HOST=localhost install - + You can manually build the Staff Client in the Staff Client source directory and set to enable automatic update checking. As the opensrf user, execute the following commands to build the Staff Client: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make AUTOUPDATE_HOST=localhost build - + For more information on Automatic Updates, see . @@ -946,14 +934,14 @@ in the directory /openils/var/web/xul, as the opensrf user execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)" cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)" - +
Packaging the Staff Client @@ -968,13 +956,13 @@ installed on your system. As the opensrf user, execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make generic-client - + The output file evergreen_staff_client.xpi will be created. @@ -1006,8 +994,8 @@ Useful icon ID strings - - + +
IDI_APPICON @@ -1022,13 +1010,13 @@
As the opensrf user execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make win-client - + The output file evergreen_staff_client_setup.exe will be created. @@ -1039,13 +1027,13 @@ bzip2 utility installed on your system. As the opensrf user, execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make linux-client - + The output file evergreen_staff_client.tar.bz2 will be created. @@ -1055,13 +1043,13 @@ utility installed on your system. As the opensrf user, execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make extension - + The output file evergreen.xpi will be created.
@@ -1108,14 +1096,14 @@ software (see ). As the opensrf user, execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2 ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname make - + During a manual Staff Client build process. @@ -1134,13 +1122,13 @@ execute the following commands to build the Staff Client (remember to replace SOME_URL with an appropriate value) : - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make AUTOUPDATE_HOST=http://SOME_URL build - + @@ -1168,29 +1156,29 @@ As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client - + Command to build all updates at once: - - + + # as the opensrf user: make updates - + commands to build updates individually: - - + + # as the opensrf user: make generic-updates make win-updates make linux-updates make extension-updates - + Building updates with clients @@ -1211,23 +1199,23 @@ As the opensrf user, execute one of the following commands: To build all updates at once: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make updates-client - + To build updates individually: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make generic-updates-client make win-updates-client make linux-updates-client - + Activating the Update Server @@ -1256,13 +1244,13 @@ manualupdate.html, and update.rdf, as the root user execute the following commands: - - + + # as the root user: cd /openils/var/updates/pub chmod +x check download manualupdate.html update.rdf - +
@@ -1285,13 +1273,13 @@ start menu. As the opensrf user, execute the following commands: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client make NSIS_EXTRAOPTS=-DPROFILES win-client - + Multiple Staff Clients @@ -1324,13 +1312,13 @@ For example, if the source files for the Evergreen installation are in the directory /home/opensrf/Evergreen-ILS-1.6.1.2/ you can start the Staff Client as shown in the following example: - - + + # as the opensrf user: cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build xulrunner application.ini - +
Assigning Workstation Names @@ -1534,31 +1522,16 @@ interfaces - anything at all in the Staff Client. Create a new tab by pressing - - Ctrl - T - + CtrlT on the keyboard or selecting: - - File - New Tab - + FileNew Tab from the menu. Close a tab by pressing - - Ctrl - W - on the keyboard or selecting - - File - Close Tab - + CtrlW on the keyboard or selecting + FileClose Tab from the menu. Switch tabs by pressing - - Ctrl - Tab - + CtrlTab on the keyboard or selecting the tab in the tab bar.
diff --git a/1.6/media/serversideinstallation-staffclient-running-1.png b/1.6/media/serversideinstallation-staffclient-running-1.png index 5d0cc7c1bf..94a4645efe 100644 Binary files a/1.6/media/serversideinstallation-staffclient-running-1.png and b/1.6/media/serversideinstallation-staffclient-running-1.png differ