From: Steve Sheppard Date: Tue, 28 Dec 2010 15:57:30 +0000 (-0500) Subject: updates to ServersideInstallation and StaffclientInstallation to bring into line... X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=b5b32f1338e2caabfea9bc89b753f36982198533;p=contrib%2FConifer.git updates to ServersideInstallation and StaffclientInstallation to bring into line with a real installation attempt; --- diff --git a/1.6/admin/serversideinstallation.xml b/1.6/admin/serversideinstallation.xml index 8f0c12cd89..a76582ec13 100644 --- a/1.6/admin/serversideinstallation.xml +++ b/1.6/admin/serversideinstallation.xml @@ -31,6 +31,7 @@ sub-components. Successful installation of Evergreen software requires that software versions agree with those listed here: + Evergreen Software Dependencies Evergreen software dependencies @@ -144,11 +145,12 @@ In the following example, the default shell for the opensrf user is automatically set to /bin/bash to inherit a reasonable environment: - - # as the root user: - useradd -m -s /bin/bash opensrf - passwd opensrf - + + + # as the root user: + useradd -m -s /bin/bash opensrf + passwd opensrf + Download and Unpack Latest OpenSRF Version @@ -162,12 +164,13 @@ the directory /home/opensrf then download and extract OpenSRF. The new subdirectory /home/opensrf/OpenSRF-1.4.0 will be created: - - # as the opensrf user: - cd /home/opensrf - wget http://evergreen-ils.org/downloads/OpenSRF-1.4.0.tar.gz - tar zxf OpenSRF-1.4.0.tar.gz - + + + # as the opensrf user: + cd /home/opensrf + wget http://evergreen-ils.org/downloads/OpenSRF-1.4.0.tar.gz + tar zxf OpenSRF-1.4.0.tar.gz + Install Prerequisites to Build OpenSRF @@ -182,16 +185,18 @@ distribution keywords table . For example, to install the prerequisites for Ubuntu version 10.04 (Lucid Lynx) you would enter this command: make -f src/extras/Makefile.install ubuntu-lucid . - - # as the root user: - cd /home/opensrf/OpenSRF-1.4.0 - make -f src/extras/Makefile.install [DISTRIBUTION] - + + + # as the root user: + cd /home/opensrf/OpenSRF-1.4.0 + make -f src/extras/Makefile.install [DISTRIBUTION] +
+ Keyword Targets for OpenSRF <application>"make"</application> Command - - + + Keyword @@ -262,12 +267,13 @@ include support for Python and Java, add the configuration options and , respectively: - - # as the opensrf user: - cd /home/opensrf/OpenSRF-1.4.0 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - + + + # as the opensrf user: + cd /home/opensrf/OpenSRF-1.4.0 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make + This step will take several minutes to complete. @@ -276,11 +282,12 @@ user, return to the new OpenSRF build directory and use the make utility to compile, link and install OpenSRF: - - # as the root user: - cd /home/opensrf/OpenSRF-1.4.0 - make install - + + + # as the root user: + cd /home/opensrf/OpenSRF-1.4.0 + make install + This step will take several minutes to complete. @@ -293,11 +300,12 @@ new library path, then run the command ldconfig to automatically read the file and modify the system dynamic library path: - - # as the root user: - echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf - ldconfig - + + + # as the root user: + echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf + ldconfig + Define Public and Private OpenSRF Domains @@ -316,11 +324,12 @@ Jabber - - # as the root user: - 127.0.1.2 public.localhost public - 127.0.1.3 private.localhost private - + + + # as the root user: + 127.0.1.2 public.localhost public + 127.0.1.3 private.localhost private + Change File Ownerships @@ -328,10 +337,11 @@ user, change the ownership of all files installed in the directory /openils to the user opensrf: - - # as the root user: - chown -R opensrf:opensrf /openils - + + + # as the root user: + chown -R opensrf:opensrf /openils + @@ -343,23 +353,25 @@ Before continuing with configuration of ejabberd you must stop that service. As the root user, execute the following command to stop the service: - - # as the root user: - /etc/init.d/ejabberd stop - + + + # as the root user: + /etc/init.d/ejabberd stop + If ejabberd reports that it is already stopped, there may have been a problem when it started back in the installation step. If there are any remaining daemon processes such as beam or epmd you may need to perform the following commands to kill them: - - # as the root user: - epmd -kill - killall beam; killall beam.smp - rm /var/lib/ejabberd/* - echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd - + + + # as the root user: + epmd -kill + killall beam; killall beam.smp + rm /var/lib/ejabberd/* + echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd + Edit the <systemitem class="service">ejabberd</systemitem> configuration @@ -371,63 +383,40 @@ Change the line: - - {hosts, ["localhost"]}. - + {hosts, ["localhost"]}. to instead read: - - {hosts, ["localhost", "private.localhost", "public.localhost"]}. - + {hosts, ["localhost", "private.localhost", "public.localhost"]}. + Change the line: - - {max_user_sessions, 10} - + {max_user_sessions, 10} to instead read: - - {max_user_sessions, 10000} - + {max_user_sessions, 10000} If the line looks something like this: - - {access, max_user_sessions, [{10, all}]} - + {access, max_user_sessions, [{10, all}]} then change it to instead read: - - {access, max_user_sessions, [{10000, all}]} - + {access, max_user_sessions, [{10000, all}]} Change all three occurrences of: - - max_stanza_size - + max_stanza_size to instead read: - - 2000000 - + 2000000 Change both occurrences of: - - maxrate - + maxrate to instead read: - - 500000 - + 500000 Comment out the line: - - {mod_offline, []} - + {mod_offline, []} by placing two % comment signs in front so it instead reads: - - %%{mod_offline, []} - + %%{mod_offline, []} @@ -436,10 +425,11 @@ As the root user, restart the ejabberd service to test the configuration changes and to register your users: - - # as the root user: - /etc/init.d/ejabberd start - + + + # as the root user: + /etc/init.d/ejabberd start + Register <systemitem class="username">router</systemitem> and @@ -470,16 +460,18 @@ <para>As the <systemitem class="username">root</systemitem> user, execute the <command>ejabberdctl</command> utility as shown below to register and create passwords for the users <systemitem class="username">router</systemitem> and - <systemitem class="username">opensrf</systemitem> on each domain:</para> - <screen> - <prompt># as the root user:</prompt> - <prompt># Note: the syntax for registering a user with ejabberdctl is:</prompt> - <prompt># ejabberdctl register USER DOMAIN PASSWORD</prompt> - <userinput>ejabberdctl register router private.localhost NEWPASSWORD</userinput> - <userinput>ejabberdctl register router public.localhost NEWPASSWORD</userinput> - <userinput>ejabberdctl register opensrf private.localhost NEWPASSWORD</userinput> - <userinput>ejabberdctl register opensrf public.localhost NEWPASSWORD</userinput> - </screen> + <systemitem class="username">opensrf</systemitem> on each domain (remember to replace + <emphasis>NEWPASSWORD</emphasis> with the appropriate password):</para> +<screen> + <userinput> + # as the root user: + # Note: the syntax for registering a user with ejabberdctl is: + # ejabberdctl register USER DOMAIN PASSWORD + ejabberdctl register router private.localhost NEWPASSWORD + ejabberdctl register router public.localhost NEWPASSWORD + ejabberdctl register opensrf private.localhost NEWPASSWORD + ejabberdctl register opensrf public.localhost NEWPASSWORD</userinput> +</screen> <para>Note that the users <systemitem class="username">router</systemitem> and <systemitem class="username">opensrf</systemitem> and their respective passwords will be used again in <xref linkend="serversideinstallation-passwords"/> when @@ -491,12 +483,13 @@ execute the following commands to create the new configuration files <filename>/openils/conf/opensrf_core.xml</filename> and <filename>/openils/conf/opensrf.xml</filename> from the example templates:</para> - <screen> - <prompt># as the opensrf user:</prompt> - <userinput>cd /openils/conf</userinput> - <userinput>cp opensrf.xml.example opensrf.xml</userinput> - <userinput>cp opensrf_core.xml.example opensrf_core.xml</userinput> - </screen> +<screen> + <userinput> + # as the opensrf user: + cd /openils/conf + cp opensrf.xml.example opensrf.xml + cp opensrf_core.xml.example opensrf_core.xml</userinput> +</screen> </step> <step xml:id="serversideinstallation-passwords"> <title>Update usernames and passwords in the OpenSRF configuration file @@ -508,6 +501,7 @@ file that needs changes. The right-hand side of the table shows the replacement values:
+ Sample XPath syntax for editing "opensrf_core.xml" @@ -593,15 +587,11 @@ file /openils/conf/opensrf.xml, then find and modify the element dbfile (near the end of the file) to set the location of the persistent database. Change the default line: - - /openils/var/persist.db - + /openils/var/persist.db to instead read: - - /tmp/persist.db - + /tmp/persist.db Following is a sample modification of that portion of the file: - @@ -628,10 +618,11 @@ to the home directory of each user who will use srfsh. For instance, do the following for the opensrf user: - - # as the root user: - cp /openils/conf/srfsh.xml.example /home/opensrf/.srfsh.xml - + + + # as the root user: + cp /openils/conf/srfsh.xml.example /home/opensrf/.srfsh.xml + Edit each user's file ~/.srfsh.xml and make the following changes: @@ -662,7 +653,7 @@ Following is a sample of the file: - @@ -685,27 +676,30 @@ environmental variable PATH by adding a new file path to the opensrf user's shell configuration file ~/.bashrc: - - # as the opensrf user: - echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc - + + + # as the opensrf user: + echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc + Start OpenSRF As the root user, start the ejabberd and memcached services: - - # as the root user: - /etc/init.d/ejabberd start - /etc/init.d/memcached start - + + + # as the root user: + /etc/init.d/ejabberd start + /etc/init.d/memcached start + As the opensrf user, start OpenSRF as follows: - - # as the opensrf user: - osrf_ctl.sh -l -a start_all - + + + # as the opensrf user: + osrf_ctl.sh -l -a start_all + The flag forces Evergreen to use localhost (your current system) as the hostname. The flag starts the other @@ -740,16 +734,19 @@ OpenSRF using the srfsh utility and trying to call the add method on the OpenSRF math service: - - # as the root user: - /openils/bin/srfsh - srfsh# request opensrf.math add 2 2 - Received Data: 4 - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 0.007519 - ------------------------------------ - + + + # as the root user: + /openils/bin/srfsh + + srfsh# request opensrf.math add 2 2 + + Received Data: 4 + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.007519 + ------------------------------------ + For other srfsh commands, type in help at the prompt. @@ -759,10 +756,11 @@ osrf_ctl.sh again. As the opensrf user, stop OpenSRF as follows: - - # as the opensrf user: - osrf_ctl.sh -l -a stop_all - + + + # as the opensrf user: + osrf_ctl.sh -l -a stop_all + @@ -835,12 +833,13 @@ the directory /home/opensrf then download and extract Evergreen. The new subdirectory /home/opensrf/Evergreen-ILS-1.6.1.2 will be created: - - # as the opensrf user: - cd /home/opensrf - wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz - tar zxf Evergreen-ILS-1.6.1.2.tar.gz - + + + # as the opensrf user: + cd /home/opensrf + wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz + tar zxf Evergreen-ILS-1.6.1.2.tar.gz + Install Prerequisites to Build Evergreen @@ -857,16 +856,18 @@ For example, to install the prerequisites for Ubuntu version 9.10 (Karmic Koala) you would enter this command: make -f Open-ILS/src/extras/Makefile.install ubuntu-karmic. - - # as the root user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - make -f Open-ILS/src/extras/Makefile.install [DISTRIBUTION] - + + + # as the root user: + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make -f Open-ILS/src/extras/Makefile.install [DISTRIBUTION] +
+ Keyword Targets for Evergreen <application>"make"</application> Command - - + + Keyword @@ -932,18 +933,20 @@ 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 - + + + # 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 - + + + # 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 + 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 @@ -962,19 +965,19 @@ You will need to install several Perl modules on the other system. As the root user install the following Perl modules: - - # as the root user: - # first, ensure the gcc compiler is installed: - apt-get install gcc - # then install the Perl modules: - perl -MCPAN -e shell - cpan> - install JSON::XS - cpan> - install MARC::Record - cpan> - install MARC::File::XML - + + + # as the root user: + # first, ensure the gcc compiler is installed: + apt-get install gcc + + # then install the Perl modules: + perl -MCPAN -e shell + + cpan> install JSON::XS + cpan> install MARC::Record + cpan> install MARC::File::XML + For more information on installing Perl Modules vist the official CPAN site. @@ -989,12 +992,13 @@ do this by creating the new file /etc/ld.so.conf.d/osrf.conf containing a new library path, then run the command ldconfig to automatically read the file and modify the system dynamic library path: - - # as the root user: - echo "/usr/local/lib" >> /etc/ld.so.conf.d/osrf.conf - echo "/usr/local/lib/dbd" >> /etc/ld.so.conf.d/osrf.conf - ldconfig - + + + # as the root user: + echo "/usr/local/lib" >> /etc/ld.so.conf.d/osrf.conf + echo "/usr/local/lib/dbd" >> /etc/ld.so.conf.d/osrf.conf + ldconfig + Restart the PostgreSQL Server @@ -1003,13 +1007,14 @@ PostgreSQL to re-read the new library paths just configured. If PostgreSQL is running on another system, you may skip this step. As the opensrf user, - execute the following command, where - [PGSQL_VERSION] is your installed PostgreSQL version - (e.g. 8.3): - - # as the opensrf user: - /etc/init.d/postgresql-[PGSQL_VERSION] restart - + execute the following command (remember to replace + PGSQL_VERSION with your installed PostgreSQL version, + for example 8.3): + + + # as the opensrf user: + /etc/init.d/postgresql-PGSQL_VERSION restart + Configure Evergreen @@ -1018,12 +1023,13 @@ and linked later in . As the opensrf user, return to the Evergreen build directory and execute these commands: - - # as the opensrf user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - + + + # as the opensrf user: + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make + Compile, Link and Install Evergreen @@ -1031,11 +1037,12 @@ default Evergreen Staff Client. As the root user, return to the Evergreen build directory and use the make utility as shown below: - - # as the root user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install - + + + # as the root user: + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install + The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. @@ -1048,11 +1055,12 @@ directory /openils/var/web/xul that points to the subdirectory /server of the new Staff Client build: - - # as the root user: - cd /openils/var/web/xul - ln -sf rel_1_6_1_2/server server - + + + # as the root user: + cd /openils/var/web/xul + ln -sf rel_1_6_1_2/server server + Copy the OpenSRF Configuration Files @@ -1064,16 +1072,17 @@ to opensrf. As the root user, execute the following commands: - - # as the root user: - cd /openils/conf - cp opensrf.xml opensrf.xml.BAK - cp opensrf_core.xml opensrf_core.xml.BAK - cp opensrf.xml.example opensrf.xml - cp opensrf_core.xml.example opensrf_core.xml - cp oils_web.xml.example oils_web.xml - chown -R opensrf:opensrf /openils/ - + + + # as the root user: + cd /openils/conf + cp opensrf.xml opensrf.xml.BAK + cp opensrf_core.xml opensrf_core.xml.BAK + cp opensrf.xml.example opensrf.xml + cp opensrf_core.xml.example opensrf_core.xml + cp oils_web.xml.example oils_web.xml + chown -R opensrf:opensrf /openils/ + Create and Configure PostgreSQL Database @@ -1085,10 +1094,10 @@ below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be - /usr/local/share/contrib; if you + /usr/local/share/contrib , and if you installed the PostgreSQL 8.3 server packages on Ubuntu 8.04, the path would be - /usr/share/postgresql/8.3/contrib/. + /usr/share/postgresql/8.3/contrib/ . @@ -1097,36 +1106,41 @@ As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: - - # as the postgres user: - createdb evergreen -E UTF8 -T template0 - createlang plperl evergreen - createlang plperlu evergreen - createlang plpgsql evergreen - + + + # as the postgres user: + createdb evergreen -E UTF8 -T template0 + createlang plperl evergreen + createlang plperlu evergreen + createlang plpgsql evergreen + Continue as the postgres user - and execute the SQL scripts as shown below, adjusting the paths as needed, where - [PGSQL_VERSION] is your installed PostgreSQL - version (e.g. 8.3). - - # as the postgres user: - psql -f /usr/share/postgresql/[PGSQL_VERSION]/contrib/tablefunc.sql evergreen - psql -f /usr/share/postgresql/[PGSQL_VERSION]/contrib/tsearch2.sql evergreen - psql -f /usr/share/postgresql/[PGSQL_VERSION]/contrib/pgxml.sql evergreen - + and execute the SQL scripts as shown below (remember to adjust the paths as needed, + where PGSQL_VERSION is your installed PostgreSQL + version, for example 8.3). + + + # as the postgres user: + psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen + psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen + psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen + Create <systemitem class="username">evergreen</systemitem> PostgreSQL user As the postgres user on the PostgreSQL system, create a new PostgreSQL user named evergreen and - assign a password: - - # as the postgres user: - createuser -P -s evergreen - Enter password for new role: MYNEWPASSWORD - Enter it again: MYNEWPASSWORD - + assign a password (remember to replace NEWPASSWORD + with an appropriate new password): + + + # as the postgres user: + createuser -P -s evergreen + + Enter password for new role: NEWPASSWORD + Enter it again: NEWPASSWORD + Create database schema @@ -1138,14 +1152,15 @@ the following commands and replace HOSTNAME, PORT, PASSWORD and DATABASENAME with appropriate values: - - # as the root user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ - --service all --create-schema --create-bootstrap --create-offline \ - --hostname HOSTNAME --port PORT \ - --user evergreen --password PASSWORD --database DATABASENAME - + + + # as the root user: + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ + --service all --create-schema --create-bootstrap --create-offline \ + --hostname HOSTNAME --port PORT \ + --user evergreen --password PASSWORD --database DATABASENAME + On most systems, HOSTNAME will be localhost and PORT will be 5432. @@ -1155,13 +1170,11 @@ As the command executes, you may see warnings similar to: ERROR: schema SOMENAME does not exist (in fact, you may see one warning per schema) but they can be safely ignored. - - If you are entering the above command on a single line, do - not include the \ (backslash) characters. If - you are using the bash shell, these should only - be used at the end of a line at a bash prompt - to indicate that the command is continued on the next line. - + If you are entering the above command on a single line, do not + include the \ (backslash) characters. If you are using + the bash shell, these should only be used at the end of + a line at a bash prompt to indicate that the command is + continued on the next line. @@ -1186,12 +1199,13 @@ Apache modules - - # as the root user: - a2enmod ssl # enable mod_ssl - a2enmod rewrite # enable mod_rewrite - a2enmod expires # enable mod_expires - + + + # as the root user: + a2enmod ssl # enable mod_ssl + a2enmod rewrite # enable mod_rewrite + a2enmod expires # enable mod_expires + As the commands execute, you may see warnings similar to: Module SOMEMODULE already enabled but you can safely ignore them. @@ -1202,13 +1216,14 @@ Evergreen installation directory to the Apache directory. As the root user, perform the following commands: - - # as the root user: - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/ - cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/ - cp Open-ILS/examples/apache/startup.pl /etc/apache2/ - + + + # as the root user: + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/ + cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/ + cp Open-ILS/examples/apache/startup.pl /etc/apache2/ + Create a Security Certificate @@ -1219,26 +1234,24 @@ accept the warnings in the Staff Client and browser during testing and development. As the root user, perform the following commands: - - # as the root user: - mkdir /etc/apache2/ssl - cd /etc/apache2/ssl - openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key - + + + # as the root user: + mkdir /etc/apache2/ssl + cd /etc/apache2/ssl + openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key + You will be prompted for several items of information; enter the appropriate information for each item. The new files server.crt and server.key will be created in the directory /etc/apache2/ssl . - - This step generates a self-signed SSL - certificate. You must install a proper SSL certificate - for a public production system to avoid warning messages - when users login to their account through the OPAC or - when staff login through the Staff Client. - For further information on installing a proper SSL - certificate, see . - + This step generates a self-signed SSL certificate. You must install + a proper SSL certificate for a public production system to avoid warning + messages when users login to their account through the OPAC or when staff + login through the Staff Client. For further information on + installing a proper SSL certificate, see + . Update Apache configuration file @@ -1251,9 +1264,10 @@ In the section <Directory "/openils/var/cgi-bin"> - replace this line: + replace the line: Allow from 10.0.0.0/8 - with this line: Allow from all. + with the line: + Allow from all This change allows access to your configuration CGI scripts from any workstation on any network. This is only a temporary change to expedite testing and should be @@ -1265,9 +1279,10 @@ - Comment out the line Listen 443, - since it conflicts with the same declaration in the - configuration file: + Comment out the line: + Listen 443 + since it conflicts with the same declaration in + the configuration file: /etc/apache2/ports.conf. Note that Debian users should not do this since the conflict does not apply to @@ -1292,33 +1307,32 @@ Ubuntu Lucid or Debian Lenny, as the root user, - edit the Apache configuration file and change these - lines: - - # as the root user: - export APACHE_RUN_USER=www-data - export APACHE_RUN_GROUP=www-data - + edit the Apache configuration file and change the lines: + + + export APACHE_RUN_USER=www-data + export APACHE_RUN_GROUP=www-data + to instead read: - - # as the root user: - export APACHE_RUN_USER=opensrf - export APACHE_RUN_GROUP=opensrf - + + + export APACHE_RUN_USER=opensrf + export APACHE_RUN_GROUP=opensrf + As the root user, edit the Apache configuration file /etc/apache2/apache2.conf and - modify the values for KeepAliveTimeout + modify the value for KeepAliveTimeout and MaxKeepAliveRequests to match the following: - - # as the root user: - KeepAliveTimeout 1 - MaxKeepAliveRequests 100 - + + + KeepAliveTimeout 1 + MaxKeepAliveRequests 100 + Further configuration changes to Apache may be @@ -1332,7 +1346,7 @@ and modify the section related to prefork configuration to suit the load on your system: - StartServers 20 MinSpareServers 5 @@ -1351,14 +1365,15 @@ following Apache configuration commands to disable the default It Works web page and enable the Evergreen web site, and then restart the Apache server: - - # as the root user: - # disable/enable web sites - a2dissite default - a2ensite eg.conf - # restart the server - /etc/init.d/apache2 reload - + + + # as the root user: + # disable/enable web sites + a2dissite default + a2ensite eg.conf + # restart the server + /etc/init.d/apache2 reload + @@ -1378,6 +1393,7 @@ file that needs changes. The right-hand side of the table shows the replacement values:
+ Sample XPath syntax for editing "opensrf_core.xml" @@ -1467,10 +1483,11 @@ Modify the permissions in the directory /openils/var/cgi-bin to make the files executable: - - # as the opensrf user: - chmod 755 /openils/var/cgi-bin/*.cgi - + + + # as the opensrf user: + chmod 755 /openils/var/cgi-bin/*.cgi + As the opensrf user, @@ -1478,21 +1495,17 @@ user opensrf by adding a Perl environmental variable, then execute the shell configuration file to load the new variables into your current environment. - - - In a multi-server environment, you must add any - modifications to ~/.bashrc to the top of - the file before the line - [ -z "$PS1" ] && return . - This will allow headless (scripted) logins to load the correct - environment. - - - - # as the opensrf user: - echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc - . ~/.bashrc - + In a multi-server environment, you must add any + modifications to ~/.bashrc to the top of the file + before the line [ -z "$PS1" ] && + return . This will allow headless (scripted) logins to load the + correct environment. + + + # as the opensrf user: + echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc + . ~/.bashrc + @@ -1515,19 +1528,21 @@ As the root user, start the ejabberd and memcached services as follows: - - # as the root user: - /etc/init.d/ejabberd start - /etc/init.d/memcached start - + + + # as the root user: + /etc/init.d/ejabberd start + /etc/init.d/memcached start + As the opensrf user, start Evergreen as follows: - - # as the opensrf user: - osrf_ctl.sh -l -a start_all - + + + # as the opensrf user: + osrf_ctl.sh -l -a start_all + The flag forces Evergreen to use localhost (your current system) as the hostname. The flag starts the other @@ -1574,40 +1589,41 @@ changes to the library hierarchy. As the opensrf user, execute the following command and review the results: - - # as the opensrf user: - cd /openils/bin - ./autogen.sh -c /openils/conf/opensrf_core.xml -u - Updating Evergreen organization tree and IDL using '/openils/conf/opensrf_core.xml' - Updating fieldmapper - Updating web_fieldmapper - Updating OrgTree - removing OrgTree from the cache for locale hy-AM... - removing OrgTree from the cache for locale cs-CZ... - removing OrgTree from the cache for locale en-CA... - removing OrgTree from the cache for locale en-US... - removing OrgTree from the cache for locale fr-CA... - removing OrgTree from the cache for locale ru-RU... - Updating OrgTree HTML - Updating locales selection HTML - Updating Search Groups - Refreshing proximity of org units - Successfully updated the organization proximity - Done - + + + # as the opensrf user: + cd /openils/bin + ./autogen.sh -c /openils/conf/opensrf_core.xml -u + + Updating Evergreen organization tree and IDL using '/openils/conf/opensrf_core.xml' + Updating fieldmapper + Updating web_fieldmapper + Updating OrgTree + removing OrgTree from the cache for locale hy-AM... + removing OrgTree from the cache for locale cs-CZ... + removing OrgTree from the cache for locale en-CA... + removing OrgTree from the cache for locale en-US... + removing OrgTree from the cache for locale fr-CA... + removing OrgTree from the cache for locale ru-RU... + Updating OrgTree HTML + Updating locales selection HTML + Updating Search Groups + Refreshing proximity of org units + Successfully updated the organization proximity + Done + As the root user, restart the Apache Web server: - - # as the root user: - /etc/init.d/apache2 restart - - - If the Apache Web server was running when you started the OpenSRF - services, you might not be able to successfully log into the OPAC or - Staff Client until the Apache Web server has been restarted. - + + + # as the root user: + /etc/init.d/apache2 restart + + If the Apache Web server was running when you started the OpenSRF + services, you might not be able to successfully log into the OPAC or Staff + Client until the Apache Web server has been restarted. @@ -1625,43 +1641,46 @@ srfsh commands, type help at the prompt. As the opensrf user, execute the following commands to test your Evergreen connection: - - # as the opensrf user: - /openils/bin/srfsh - srfsh% - login admin open-ils - Received Data: "250bf1518c7527a03249858687714376" - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 0.045286 - ------------------------------------ - Received Data: { - "ilsevent":0, - "textcode":"SUCCESS", - "desc":" ", - "pid":21616, - "stacktrace":"oils_auth.c:304", - "payload":{ - "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a", - "authtime":420 - } - } - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 1.336568 - ------------------------------------ - + + + # as the opensrf user: + /openils/bin/srfsh + + srfsh% login admin open-ils + Received Data: "250bf1518c7527a03249858687714376" + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.045286 + ------------------------------------ + Received Data: { + "ilsevent":0, + "textcode":"SUCCESS", + "desc":" ", + "pid":21616, + "stacktrace":"oils_auth.c:304", + "payload":{ + "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a", + "authtime":420 + } + } + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 1.336568 + ------------------------------------ + + If this does not work, try the following: As the opensrf user, run the settings-tester.pl utility to review your Evergreen installation for any system configuration problems: - - # as the opensrf user: - cd /home/opensrf - ./Evergreen-ILS-1.6.1.2/Open-ILS/src/support-scripts/settings-tester.pl - + + + # as the opensrf user: + cd /home/opensrf + ./Evergreen-ILS-1.6.1.2/Open-ILS/src/support-scripts/settings-tester.pl + If the output of settings-tester.pl does not help you find the problem, please do not make any significant changes to your configuration. @@ -1689,10 +1708,11 @@ version 3.0 and later on Ubuntu and Debian distributions). As the root user, start the Staff Client as shown: - - # as the root user: - xulrunner /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build/application.ini - + + + # 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: Logging into the Staff Client @@ -1738,10 +1758,11 @@ commands. Note the use of restart to force the new Evergreen modules to be reloaded even if the Apache server is already running. Any problems found with your configuration files should be displayed: - - # as the root user: - apache2ctl configtest && /etc/init.d/apache2 restart - + + + # as the root user: + apache2ctl configtest && /etc/init.d/apache2 restart + Stopping Evergreen @@ -1750,19 +1771,17 @@ Evergreen services. As the opensrf user, stop all Evergreen services by using the following command: - - # as the opensrf user - # stop the server; use "-l" to force hostname to be "localhost" - osrf_ctl.sh -l -a stop_all - - - You can also stop Evergreen services - without the flag, but the - osrf_ctl.sh utility must know the fully qualified domain name - for the system on which it will execute. That hostname may have been specified - in the configuration file opensrf.xml, which you configured - in a previous step. - + + + # as the opensrf user + # stop the server; use "-l" to force hostname to be "localhost" + osrf_ctl.sh -l -a stop_all + + You can also stop Evergreen services without the + flag, but the osrf_ctl.sh utility must know the + fully qualified domain name for the system on which it will execute. That hostname may + have been specified in the configuration file opensrf.xml, which + you configured in a previous step.
@@ -1834,11 +1853,12 @@ 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 - + + + # 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: @@ -1865,13 +1885,14 @@ 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 - + + + # 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 +
@@ -1909,7 +1930,7 @@ this section are further descriptions of installing Linux and Evergreen systems using that virtualization software. - +
Installing <application>"VirtualBox"</application> Virtualization Software This section reviews installation of the "VirtualBox" application on @@ -1917,8 +1938,8 @@ Download the latest edition of VirtualBox from their official website: http://virtualbox.org and follow the on screen instructions to install the software. - - +
+
Installing VMware Virtualization Software virtualization software @@ -1931,7 +1952,7 @@ official website: http://downloads.vmware.com and follow the on-screen instructions. - +
Installing <systemitem class="osname">Linux</systemitem> / @@ -1952,7 +1973,7 @@ </listitem> </orderedlist> <para>We review each method in the following sections.</para> - <simplesect xml:id="serversideinstall-virtual-prebuilt"> + <section xml:id="serversideinstall-virtual-prebuilt"> <title>Download and install a prebuilt software image You can download a prebuilt software image that, when installed with your virtualization software, emulates a @@ -1970,12 +1991,13 @@ of the Evergreen community for the purposes of testing, evaluation, training, and development.
+ Linux / Evergreen Virtual Images - - - - + + + + Linux Version @@ -2012,8 +2034,7 @@ Start VirtualBox for the first time and select - FileVirtualBox Media - ManagerAdd + FileVirtualBox Media ManagerAdd to locate the prebuilt software image just downloaded (the example shows it was extracted from the original zip file into a temporary directory @@ -2063,11 +2084,11 @@ Linux and Evergreen. After some delay you should see the command line prompt debian-lenny login:. Log in with username - root and password evergreen + root and password evergreen to continue. - + diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index fdbf8f2a56..38b839b95c 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -154,10 +154,17 @@ to match the Evergreen version. See the following table for the recommended version of XULrunner:
+ Evergreen / <application>XULrunner</application> Dependencies - - - + + + + + + Evergreen Version + XULRunner Version + + Evergreen 1.6.x.x @@ -184,9 +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 - + + + /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. @@ -215,10 +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 - + + + 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 @@ -229,19 +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 - + + + 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 - + + + 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 @@ -285,18 +300,20 @@ Make a copy of the folder /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 - + + + 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 the @@ -305,16 +322,18 @@ Make Evergreen.app/Resources the root of your Evergreen application files like this: - - Evergreen.app/ - __Contents/ - ____Resources/ - ______BUILD_ID - ______application.ini - ______chrome/ - ______components/ - ______etc. - + + + Evergreen.app/ + __Contents/ + ____Resources/ + ______BUILD_ID + ______application.ini + ______chrome/ + ______components/ + ______etc. + + Put a Mac format icon file named Evergreen.icns in @@ -334,15 +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/ - + + + 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 - + + + xulrunner /SOME_PATH/build/application.ini + + Building the Staff Client on the Server @@ -373,11 +396,14 @@ 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 - + + + # 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 @@ -404,11 +430,14 @@ 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 - + + + # as the root user: + + sudo apt-get install subversion + sudo apt-get install xulrunner + + Download the Source Code @@ -447,11 +476,14 @@ 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/ - + + + # 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. @@ -472,26 +504,32 @@ 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 - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - ./configure --prefix=/openils --sysconfdir=/openils/conf - cd ./Open-ILS/xul/staff_client/ - make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install - + + + # 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 + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf + 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 - + + + # 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 @@ -504,39 +542,49 @@ 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 - + + + # 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 - + + + # 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 - + + + # as the opensrf user: + + rm -r -f ~/DOWNLOAD_DIRECTORY + + Finally, the command: - - # as the opensrf user - xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini - + + + # 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 - - + Desktop + StartMenu + K-Menu + @@ -562,10 +610,13 @@ Install wine: - - # as the root user - sudo apt-get install wine - + + + # as the root user: + + sudo apt-get install wine + + Visit the downloads section of the Evergreen website at @@ -582,11 +633,14 @@ 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 - + + + # 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, @@ -603,14 +657,16 @@ 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. + 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. @@ -630,29 +686,39 @@ 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. 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 - + + + # 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=NEWVERSION build - + + + # as the opensrf user: + + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make STAFF_CLIENT_BUILD_ID=NEWVERSION build + + - <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 @@ -660,11 +726,14 @@ 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 - + + + # 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 @@ -674,14 +743,19 @@ 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 - + + + # 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 + + - <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 @@ -689,20 +763,26 @@ 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 - + + + # 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 - + + + # 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 + +
@@ -719,9 +799,10 @@ possible make target keywords:
Keywords Targets for "make" Command + - - + + Keyword @@ -803,11 +884,14 @@ 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 - + + + # as the opensrf user: + + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make devbuild + + Compressed Javascript @@ -820,43 +904,55 @@ 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 - + + + # 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 commands from the Staff Client source directory: In the following make below, 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 - + + + # 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 - + + + # 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 - + + + # 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 . @@ -873,12 +969,15 @@ 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)" - + + + # 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 @@ -893,13 +992,15 @@ 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 - + + + # 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. - Packaging a <systemitem class="osname">Windows</systemitem> Client @@ -927,10 +1028,11 @@ Windows executables. Some useful icon ID strings include the following:
+ Useful icon ID strings - - + + IDI_APPICON @@ -945,11 +1047,14 @@
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 - + + + # 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. @@ -960,11 +1065,14 @@ 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 - + + + # 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. @@ -974,11 +1082,14 @@ 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 - + + + # 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. @@ -1025,12 +1136,15 @@ 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 - + + + # 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. @@ -1049,11 +1163,14 @@ 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 - + + + # 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 + + @@ -1081,23 +1198,32 @@ 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 - + + + # 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 - + + + # 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 - + + + # as the opensrf user: + + make generic-updates + make win-updates + make linux-updates + make extension-updates + + Building updates with clients @@ -1118,19 +1244,25 @@ 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 - + + + # 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 - + + + # 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 @@ -1159,11 +1291,14 @@ 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 - + + + # as the root user: + + cd /openils/var/updates/pub + chmod +x check download manualupdate.html update.rdf + +
@@ -1186,11 +1321,14 @@ 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 - + + + # 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 @@ -1223,11 +1361,14 @@ 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 - + + + # 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 @@ -1324,17 +1465,18 @@ tunnel in PuTTY - + - Using the menu on the left, find the section - - Connection - SSH - Tunnels - + Using the menu on the left, find the section: + + + Connection + SSH + Tunnels + @@ -1434,7 +1576,7 @@ Ctrl T - on the keyboard or selecting + on the keyboard or selecting: File New Tab @@ -1454,7 +1596,8 @@ Ctrl Tab - on the keyboard or selecting the tab in the tab bar. + + 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 6f61fb800d..5d0cc7c1bf 100644 Binary files a/1.6/media/serversideinstallation-staffclient-running-1.png and b/1.6/media/serversideinstallation-staffclient-running-1.png differ diff --git a/1.6/media/serversideinstallation-staffclient-running-2.png b/1.6/media/serversideinstallation-staffclient-running-2.png index 33abe1371a..d25a0f616f 100644 Binary files a/1.6/media/serversideinstallation-staffclient-running-2.png and b/1.6/media/serversideinstallation-staffclient-running-2.png differ diff --git a/1.6/media/serversideinstallation-staffclient-running-4.png b/1.6/media/serversideinstallation-staffclient-running-4.png index c328ed3456..b667059063 100644 Binary files a/1.6/media/serversideinstallation-staffclient-running-4.png and b/1.6/media/serversideinstallation-staffclient-running-4.png differ diff --git a/1.6/media/staffclientinstallation-proxy-putty-1.png b/1.6/media/staffclientinstallation-proxy-putty-1.png new file mode 100644 index 0000000000..1558fb665c Binary files /dev/null and b/1.6/media/staffclientinstallation-proxy-putty-1.png differ diff --git a/1.6/media/staffclientinstallation-proxy-putty.png b/1.6/media/staffclientinstallation-proxy-putty.png deleted file mode 100644 index ea3d81dbe2..0000000000 Binary files a/1.6/media/staffclientinstallation-proxy-putty.png and /dev/null differ diff --git a/1.6/media/staffclientinstallation-proxy-socks-1.png b/1.6/media/staffclientinstallation-proxy-socks-1.png index 17f1c5e149..b43192b910 100644 Binary files a/1.6/media/staffclientinstallation-proxy-socks-1.png and b/1.6/media/staffclientinstallation-proxy-socks-1.png differ diff --git a/1.6/media/staffclientinstallation-proxy-socks-2.png b/1.6/media/staffclientinstallation-proxy-socks-2.png index de3b8b2c07..5f9088dbca 100644 Binary files a/1.6/media/staffclientinstallation-proxy-socks-2.png and b/1.6/media/staffclientinstallation-proxy-socks-2.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-1.png b/1.6/media/staffclientinstallation-staffclient-1.png index b47a033370..1c19db00f0 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-1.png and b/1.6/media/staffclientinstallation-staffclient-1.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-2.png b/1.6/media/staffclientinstallation-staffclient-2.png index dd224ab0d2..a75f0565e0 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-2.png and b/1.6/media/staffclientinstallation-staffclient-2.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-workstationnames-1.png b/1.6/media/staffclientinstallation-staffclient-workstationnames-1.png index 77c1310698..b219531428 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-workstationnames-1.png and b/1.6/media/staffclientinstallation-staffclient-workstationnames-1.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-workstationnames-2.png b/1.6/media/staffclientinstallation-staffclient-workstationnames-2.png index 0ce16e2702..6c70b438ef 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-workstationnames-2.png and b/1.6/media/staffclientinstallation-staffclient-workstationnames-2.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-workstationnames-3.png b/1.6/media/staffclientinstallation-staffclient-workstationnames-3.png index 80278d2edc..7af39674bc 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-workstationnames-3.png and b/1.6/media/staffclientinstallation-staffclient-workstationnames-3.png differ diff --git a/1.6/media/staffclientinstallation-tabbed-1.png b/1.6/media/staffclientinstallation-tabbed-1.png index 15c6e0a86a..d5ae3bebf7 100644 Binary files a/1.6/media/staffclientinstallation-tabbed-1.png and b/1.6/media/staffclientinstallation-tabbed-1.png differ