tweak <screen/> sections; update the 'Post-Installation Chores' section; update the...
authorSteve Sheppard <ssheps@gmail.com>
Mon, 3 Jan 2011 20:50:58 +0000 (15:50 -0500)
committerSteve Sheppard <ssheps@gmail.com>
Mon, 3 Jan 2011 20:50:58 +0000 (15:50 -0500)
1.6/admin/serversideinstallation.xml
1.6/admin/staffclientinstallation.xml
1.6/media/serversideinstallation-staffclient-running-1.png

index a76582e..94d612f 100644 (file)
                                        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
-                                       <link xl:href="http://www.postgresql.org/">PostgreSQL Site</link>.</para>
-                                       <para>For <systemitem class="osname">Debian Lenny</systemitem> and 
-                                       <systemitem class="osname">Ubuntu Hardy (8.04)</systemitem>, execute these commands:</para>
-<screen>
-       <userinput>
-       # 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</userinput>
-</screen>
-                                       <para>For <systemitem class="osname">Ubuntu Karmic (9.10)</systemitem> and
-                                       <systemitem class="osname">Ubuntu Lucid (10.04)</systemitem>, execute these commands:</para>
-<screen>
-       <userinput>
-       # 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</userinput>
-</screen>
+                                       software, you can install the required PostgreSQL server packages as described
+                                       in <xref linkend="InstallingPostgreSQL-all"/>, or you can visit the official 
+                                       web site <link xl:href="http://www.postgresql.org/">http://www.postgresql.org</link>
+                                       for more information.</para>
                                        <note>
                                                <para>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 <systemitem class="username">postgres</systemitem> 
+                                               should upgrade before installing Evergreen. To find your current version 
+                                               of PostgreSQL, as the <systemitem class="username">postgres</systemitem> 
                                                user execute the command <command>psql</command>, then type 
                                                <userinput>SELECT version();</userinput> to get detailed information 
                                                about your version of PostgreSQL.</para>
                                        <para>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
-                                       <xref linkend="enabling_and_disabling_localization"/>.</para>
+                                       <xref linkend="languagesandlocalization"/>.</para>
                                </step>
                        </procedure>
                </section>
        # as the root user:
        xulrunner /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build/application.ini</userinput>
 </screen>
-                               <para>The login screen for the Staff Client should appear:</para>
+                               <para>A login screen for the Staff Client similar to this should appear:</para>
                                <mediaobject>
                                        <alt>Logging into the Staff Client</alt>
                                        <imageobject>
                        </section>
                        <section xml:id="serversideinstallation-ssl">
                                <title>Configure a permanent SSL key</title>
-                               <para>In a previous step (see <xref linkend="serversideinstallation-createsslcertificate"/>)
-                               you used the command <command>openssl</command> 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.</para>
-                               <para>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:</para>
+                               <para>You used the command <command>openssl</command> in an earlier step to
+                               temporarily create a new SSL key for the Apache server (see 
+                               <xref linkend="serversideinstallation-createsslcertificate"/> 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.</para>
+                               <para>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:</para>
                                <itemizedlist>
                                        <listitem>
                                                <ulink url="http://www.openca.org/projects/openca/">http://www.openca.org/projects/openca/</ulink>
                        <section>
                                <title>(OPTIONAL) Set Up Support For Reports</title>
                                <para>Evergreen reports are extremely powerful but require some simple configuration.
-                               This section describes starting and stopping the Reporter daemon processes.</para>
-                               <itemizedlist>
-                                       <listitem>
-                                               <para>Starting the Reporter Daemon</para>
-                                               <para>Once the <systemitem class="daemon">open-ils.reporter</systemitem>
-                                               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.</para>
-                                               <para>As the <systemitem class="username">opensrf</systemitem> user,
-                                               start the Reporter daemon using the following command:</para>
-<screen>
-       <userinput>
-       # as the opensrf user:
-       cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/src/reporter
-       ./clark-kent.pl --daemon</userinput>
-</screen>
-                                               <para>You can control how the <command>clark-kent.pl</command> utility behaves
-                                               by specifying any of several command-line options:</para>
-                                               <itemizedlist>
-                                                       <listitem><option>--sleep=interval</option> : number of seconds
-                                                       to sleep between checks for new reports to run; defaults to
-                                                       <literal>10</literal></listitem>
-                                                       <listitem><option>--lockfile=filename</option> : where to place
-                                                       the lockfile for the process; defaults to
-                                                       <filename>/tmp/reporter-LOCK</filename></listitem>
-                                                       <listitem><option>--concurrency=integer</option> : number of
-                                                       Reporter daemon processes to run; defaults to
-                                                       <literal>1</literal></listitem>
-                                                       <listitem><option>--bootstrap=filename</option> : OpenSRF
-                                                       bootstrap configuration file; defaults to
-                                                       <filename>/openils/conf/opensrf_core.xml</filename></listitem>
-                                               </itemizedlist>
-                                       </listitem>
-                                       <listitem>
-                                               <para>Stopping the Reporter Daemon</para>
-                                               <para>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
-                                               <literal>--concurrency</literal> switch. It will also have a lockfile
-                                               in the default location.</para>
-                                               <para>As the <systemitem class="username">opensrf</systemitem> user,
-                                               execute the following shell commands:</para>
-<screen>
-       <userinput>
-       # 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</userinput>
-</screen>
-                                       </listitem>
-                               </itemizedlist>
+                               See <xref linkend="report_starting_reporter_service"/> for information on starting and
+                               stopping the Reporter daemon processes.</para>
                        </section>
                </section>
                <section xml:id="serversideinstallation-virtual">
index 8a11420..1d88330 100644 (file)
                                        <table xml:id="staffclientinstallation-table-1">
                                                <?dbfo keep-together="always" ?>
                                                <title>Evergreen / <application>XULrunner</application> Dependencies</title>
-                                               <tgroup cols="2" align="left" colsep="1" rowsep="1">
-                                                       <colspec colnum="1" colname="evergreen_version" colwidth="1.0*"/>
-                                                       <colspec colnum="2" colname="xulrunner_version" colwidth="1.0*"/>
+                                               <tgroup align="left" cols="2" colsep="1" rowsep="1">
+                                                       <colspec colname="evergreen_version" colnum="1" colwidth="1.0*"/>
+                                                       <colspec colname="xulrunner_version" colnum="2" colwidth="1.0*"/>
                                                        <thead>
                                                                <row>
                                                                        <entry>Evergreen Version</entry>
                                        <filename class="directory">~/Desktop/Evergreen_Staff_Client</filename>).</para>
                                        <para>Remember to call <application>XULrunner</application> with the full path to the
                                        binary, followed by the install command and the path to the client data:</para>
-<screen>
-       <userinput>
+                                       <screen>
+                                               <userinput>
        /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client
        </userinput>
-</screen>
+                                       </screen>
                                        <para>The command should exit quietly and will create the folder 
                                        <filename class="directory">/Applications/OpenILS</filename>,
                                        containing a launcher named <application>open_ils_staff_client</application>.</para>
                                        <title>(OPTIONAL) Flush Receiptdb file:</title>
                                        <para>First, get the package identifier, then purge/forget the build that was
                                        initially installed:</para>
-<screen>
-       <userinput>
+                                       <screen>
+                                               <userinput>
        sudo pkgutil --pkgs > /tmp/pkgs.txt
        sudo pkgutil --forget org.mozilla.xulrunner
        </userinput>
-</screen>
+                                       </screen>
                                        <note>It may not be necessary to edit the file
                                        <filename>/Library/Receipts/InstallHistory.plist</filename> after deleting the
                                        folder <filename class="directory">XUL.framework</filename>. See
                                <simplesect>
                                        <title>Creating an APP file: Staff Client and <application>XULrunner</application> Bundled</title>
                                        <para>An APP file is basically a folder. Start with a folder stucture like this:</para>
-<screen>
-       <prompt>
+                                       <screen>
+                                               <prompt>
        Evergreen.app
        __Contents
        ____Frameworks
        ____Resources
        ____MacOS
        </prompt>
-</screen>
+                                       </screen>
                                        <para>Create an APP folder structure with the following commands:</para>
-<screen>
-       <userinput>
+                                       <screen>
+                                               <userinput>
        mkdir -p Evergreen.app/Contents/Frameworks
        mkdir -p Evergreen.app/Contents/Resources
        mkdir -p Evergreen.app/Contents/MacOS
        </userinput>
-</screen>
+                                       </screen>
                                        <orderedlist>
                                                <listitem>
                                                        <para>Create a new file in the folder
                                                        <para>Make a copy of the folder
                                                        <filename class="directory">/Library/Frameworks/XUL.Framework</filename>
                                                        inside your APP file. It should look something like this:</para>
-<screen>
-       <prompt>
+                                                       <screen>
+                                                               <prompt>
        Evergreen.app/
        __Contents/
        ____Frameworks/
        ______libxpcom.dylib -> Versions/Current/libxpcom.dylib
        ______xulrunner-bin -> Versions/Current/xulrunner-bin
        </prompt>
-</screen>
+                                                       </screen>
                                                </listitem>
                                                <listitem>Copy
                                                <filename>XUL.Framework/Versions/Current/xulrunner</filename> into the
                                                <listitem>
                                                        <para>Make <filename>Evergreen.app/Resources</filename> the root
                                                        of your Evergreen application files like this:</para>
-<screen>
-       <prompt>
+                                                       <screen>
+                                                               <prompt>
        Evergreen.app/
        __Contents/
        ____Resources/
        ______components/
        ______etc.
        </prompt>
-</screen>
+                                                       </screen>
                                                </listitem>
                                                <listitem>Put a <systemitem class="osname">Mac</systemitem> 
                                                format icon file named <filename>Evergreen.icns</filename> in 
                                        <para>Execute the following commands, replacing <literal>USER</literal>,
                                        <literal>WORKSTATION</literal>, and <literal>SOME_PATH</literal> with
                                        appropriate values:</para>
-<screen>
-       <userinput>
+                                       <screen>
+                                               <userinput>
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        scp -r ./build USER@WORKSTATION:/SOME_PATH/
        </userinput>
-</screen>
+                                       </screen>
                                        <para>You should test the newly copied Staff Client on the remote workstation.
                                        Log into the workstation and execute the following command:</para>
-<screen>
-       <userinput>
+                                       <screen>
+                                               <userinput>
        xulrunner /SOME_PATH/build/application.ini
        </userinput>
-</screen>
+                                       </screen>
                                </simplesect>
                                <simplesect>
                                        <title>Building the Staff Client on the Server</title>
                                        directory containing the server components of the Staff Client, or the name of a
                                        symbolic link to that directory. As the 
                                        <systemitem class="username">root</systemitem> user, make the changes as follows:</para>
-<screen>
-       <userinput>
+                                       <screen>
+                                               <userinput>
        # as the root user:
        cd /openils/var/web/xul
        ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID
        </userinput>
-</screen>
+                                       </screen>
                                </simplesect>
                                <simplesect>
                                        <title>Building the Staff Client on a Client Machine</title>
                                                        <command>apt-get</command>. For <application>subversion</application>,
                                                        select the latest version; for <application>XULrunner</application>,
                                                        select version <emphasis>1.8.1.4-2ubuntu5</emphasis>.</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the root user:
        sudo apt-get install subversion
        sudo apt-get install xulrunner
        </userinput>
-</screen>
+                                                       </screen>
                                                </step>
                                                <step>
                                                        <title>Download the Source Code</title>
                                                                        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:</para>
-<screen>
-       <userinput>
+                                                                       <screen>
+                                                                               <userinput>
        # as the opensrf user:
        cd /DOWNLOAD/DIRECTORY
        svn co rel_1_6_1_2/
        </userinput>
-</screen>
+                                                                       </screen>
                                                                        <para>Remember to change "rel_1_6_1_2" to the appropriate
                                                                        tag for your installation.</para>
                                                                </listitem>
                                                        commands accordingly.</para>
                                                        <para>As the <systemitem class="username">opensrf</systemitem>
                                                        user, run the following commands to build the Staff Client:</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # 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 ./Open-ILS/xul/staff_client/
        make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install
        </userinput>
-</screen>
+                                                       </screen>
                                                </step>
                                                <step>
                                                        <title>Run the Staff Client</title>
                                                        <para>As the <systemitem class="username">opensrf</systemitem> 
                                                        user, navigate to the <filename class="directory">build/</filename>
                                                        subdirectory and run the following command:</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build
        xulrunner application.ini
        </userinput>
-</screen>
+                                                       </screen>
                                                </step>
                                                <step>
                                                        <title>(OPTIONAL) Clean Up / Create Shortcuts</title>
                                                        to replace <emphasis>DOWNLOAD_DIRECTORY</emphasis> and
                                                        <emphasis>STAGING_DIRECTORY</emphasis> with the appropriate
                                                        paths):</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the opensrf user:
        mkdir ~/STAGING_DIRECTORY
        cd ~/DOWNLOAD_DIRECTORY/Open-ILS/xul/
        cp -r staff_client ~/STAGING_DIRECTORY
        </userinput>
-</screen>
+                                                       </screen>
                                                        <para>Test the Staff Client to verify that all necessary files
                                                        were copied to the staging directory:</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the opensrf user:
        cd ~/STAGING_DIRECTORY/staff_client/build
        xulrunner application.ini
        </userinput>
-</screen>
+                                                       </screen>
                                                        <para>If there were no problems, then finish the cleanup by
                                                        removing the original download directory as shown:</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the opensrf user:
        rm -r -f ~/DOWNLOAD_DIRECTORY
        </userinput>
-</screen>
+                                                       </screen>
                                                        <para>Finally, the command:</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the opensrf user:
        xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini
        </userinput>
-</screen>
+                                                       </screen>
                                                        <para>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:
-                                                       <menuchoice><guimenu>Desktop</guimenu>
-                                                       <guimenuitem>StartMenu</guimenuitem>
-                                                       <guimenuitem>K-Menu</guimenuitem>
-                                                       </menuchoice></para>
+                                                       <menuchoice><guimenu>Desktop</guimenu><guimenuitem>StartMenu</guimenuitem><guimenuitem>K-Menu</guimenuitem></menuchoice></para>
                                                </step>
                                        </procedure>
                                </simplesect>
                                        <orderedlist>
                                                <listitem>
                                                        <para>Install wine:</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the root user:
        sudo apt-get install wine
        </userinput>
-</screen>
+                                                       </screen>
                                                </listitem>
                                                <listitem>
                                                        <para>Visit the downloads section of the Evergreen website at
                                                        file, then execute it with the <application>wine</application>
                                                        application (remember to replace <emphasis>VERSION</emphasis> with
                                                        the release number of the Staff Client you downloaded):</para>
-<screen>
-       <userinput>
+                                                       <screen>
+                                                               <userinput>
        # as the opensrf user:
        cd /TEMP_DIRECTORY
        wine evergreen-setup-rel_VERSION.exe
        </userinput>
-</screen>
+                                                       </screen>
                                                        <para>If this step fails, you may need to configure
                                                        <application>Wine</application> first to properly emulate 
                                                        <systemitem class="osname">Windows XP</systemitem>. To do so,
                                                        the Staff Client. To launch the Staff Client, visit the
                                                        <literal>All Applications</literal> menu on your desktop and
                                                        find the section similar to:</para>
-                                                       <para>
-                                                               <menuchoice>
-                                                                       <guimenu>Wine</guimenu>
-                                                                       <guimenuitem>Program Files</guimenuitem>
-                                                                       <guimenuitem>Evergreen Staff Client</guimenuitem>
-                                                                       <guimenuitem>Evergreen Staff Client</guimenuitem>
-                                                               </menuchoice>,
+                                                       <para><menuchoice><guimenu>Wine</guimenu><guimenuitem>Program Files</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem></menuchoice>,
                                                        </para>
                                                        <para>or else launch the Staff Client from the new desktop shortcut.</para>
                                                </listitem>
                        process:</para>
                        <simplesect>
                                <title>
-                                       Build Variable <envar>STAFF_CLIENT_BUILD_ID</envar>
-                               </title>
+                                       Build Variable <envar>STAFF_CLIENT_BUILD_ID</envar></title>
                                <para>During the normal <emphasis>make install</emphasis> Evergreen server-side
                                software build process, the variable defaults to an automatically generated
                                date/time string, but you can also override the value of <envar>BUILD_ID</envar>.</para>
                                <para>You could use the following commands during the normal install process:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        make STAFF_CLIENT_BUILD_ID=1_6_1_2 install
        </userinput>
-</screen>
+                               </screen>
                                <para>You can also manually build the Staff Client in the Staff Client
                                source directory with a different <envar>BUILD_ID</envar>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client (remember to replace
                                <emphasis>NEW_VERSION</emphasis> with an appropriate value):</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # 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
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect>
                                <title>
-                                       Build Variable <envar>STAFF_CLIENT_VERSION</envar>
-                               </title>
+                                       Build Variable <envar>STAFF_CLIENT_VERSION</envar></title>
                                <para>During the normal <emphasis>make install</emphasis> Evergreen server-side
                                software build process, the variable is pulled automatically from a README file
                                in the Evergreen source root. The variable defaults to
                                automatically generated. You can override the value of <envar>VERSION</envar>
                                similarly to the <envar>BUILD_ID</envar>.</para>
                                <para>You could use the following commands during the normal install process:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        make STAFF_CLIENT_VERSION=0mytest.200 install
        </userinput>
-</screen>
+                               </screen>
                                <para>You can also manually build the Staff Client in the Staff Client
                                source directory with a different <envar>VERSION</envar>.</para>
                                <para>If you plan to make extensions update automatically, the 
                                versions.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # 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
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect>
                                <title>
-                                       Build Variable <envar>STAFF_CLIENT_STAMP_ID</envar>
-                               </title>
+                                       Build Variable <envar>STAFF_CLIENT_STAMP_ID</envar></title>
                                <para>During the normal <emphasis>make install</emphasis> Evergreen
                                server-side software build process, the variable is generated from
                                <envar>STAFF_CLIENT_VERSION</envar>. You may want to have multiple versions
                                client-side customizations. You can override the value of
                                <envar>STAMP_ID</envar> similarly to the <envar>BUILD_ID</envar>.</para>
                                <para>You could use the following commands during the normal install process:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        make STAFF_CLIENT_STAMP_ID=my_test_stamp install
        </userinput>
-</screen>
+                               </screen>
                                <para>You can also manually build the Staff Client in the Staff Client
                                source directory with a different <envar>STAMP_ID</envar>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # 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
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                </section>
                <section>
                                <title>Keywords Targets for "make" Command</title>
                                <?dbfo keep-together="always" ?>
                                <tgroup align="left" cols="2" colsep="1" rowsep="1">
-                                       <colspec colnum="1" colname="keyword" colwidth="1.0*"/>
-                                       <colspec colnum="2" colname="description" colwidth="3.0*"/>
+                                       <colspec colname="keyword" colnum="1" colwidth="1.0*"/>
+                                       <colspec colname="description" colnum="2" colwidth="3.0*"/>
                                        <thead>
                                                <row>
                                                        <entry>Keyword</entry>
                                extra configuration file that enables some developer options.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, run
                                the following commands from the Staff Client source directory:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make devbuild
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect>
                                <title>Compressed Javascript</title>
                                http://code.google.com/closure/compiler</ulink>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, run
                                the following commands from the Staff Client source directory:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make compress-javascript
        </userinput>
-</screen>
+                               </screen>
                                <para>You can also combine Javascript review and compression, and also perform a
                                <emphasis>developer build</emphasis>.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, run 
                                the following <command>make</command> command from the Staff Client source directory
                                (the order of options is important):</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make  devbuild  compress-javascript
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect xml:id="staffclientinstallation-autoupdatehost">
                                <title>Automatic Update Host</title>
                                <para>You can override the host used to check for automatic Staff Client updates
                                by specifying the <option>AUTOUPDATE_HOST</option> option.</para>
                                <para>You could use the following commands during the normal install process:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the root user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        make AUTOUPDATE_HOST=localhost install
        </userinput>
-</screen>
+                               </screen>
                                <para>You can manually build the Staff Client in the Staff Client
                                source directory and set <option>AUTOUPDATE_HOST</option> to enable automatic
                                update checking.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands to build the Staff Client:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make AUTOUPDATE_HOST=localhost build
        </userinput>
-</screen>
+                               </screen>
                                <para>For more information on Automatic Updates, see
                                <xref linkend="staffclientinstallation-autoupdate"/>.</para>
                        </simplesect>
                        in the directory <filename class="directory">/openils/var/web/xul</filename>, as the
                        <systemitem class="username">opensrf</systemitem> user execute the following
                        commands:</para>
-<screen>
-       <userinput>
+                       <screen>
+                               <userinput>
        # 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)"
        </userinput>
-</screen>
+                       </screen>
                </section>
                <section>
                        <title>Packaging the Staff Client</title>
                                installed on your system.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, execute
                                the following commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make generic-client
        </userinput>
-</screen>
+                               </screen>
                                <para>The output file <filename>evergreen_staff_client.xpi</filename> will be created.</para>
                        </simplesect>
                        <simplesect>
                                        <?dbfo keep-together="always" ?>
                                        <title>Useful icon ID strings</title>
                                        <tgroup align="left" cols="2" colsep="1" rowsep="1">
-                                               <colspec colnum="1" colname="keyword" colwidth="1.0*"/>
-                                               <colspec colnum="2" colname="icon" colwidth="1.0*"/>
+                                               <colspec colname="keyword" colnum="1" colwidth="1.0*"/>
+                                               <colspec colname="icon" colnum="2" colwidth="1.0*"/>
                                                <tbody>
                                                        <row>
                                                                <entry>IDI_APPICON</entry>
                                </table>
                                <para>As the <systemitem class="username">opensrf</systemitem> user
                                execute the following commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make win-client
        </userinput>
-</screen>
+                               </screen>
                                <para>The output file <filename>evergreen_staff_client_setup.exe</filename> will be created.</para>
                        </simplesect>
                        <simplesect>
                                <application>bzip2</application> utility installed on your system.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, 
                                execute the following commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make linux-client
        </userinput>
-</screen>
+                               </screen>
                                <para>The output file <filename>evergreen_staff_client.tar.bz2</filename> will be created.</para>
                        </simplesect>
                        <simplesect>
                                utility installed on your system.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user,
                                execute the following commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make extension
        </userinput>
-</screen>
+                               </screen>
                                <para>The output file <filename>evergreen.xpi</filename> will be created.</para>
                        </simplesect>
                </section>
                                                software (see <xref linkend="serversideinstallation-configure"/>). 
                                                As the <systemitem class="username">opensrf</systemitem> user, execute 
                                                the following commands:</para>
-<screen>
-       <userinput>
+                                               <screen>
+                                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2
        ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname
        make
        </userinput>
-</screen>
+                                               </screen>
                                        </listitem>
                                        <listitem>
                                                <para>During a manual Staff Client build process.</para>
                                                execute the following commands to build the Staff Client (remember to
                                                replace <emphasis>SOME_URL</emphasis> with an appropriate value)
                                                :</para>
-<screen>
-       <userinput>
+                                               <screen>
+                                                       <userinput>
        # 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
        </userinput>
-</screen>
+                                               </screen>
                                        </listitem>
                                </itemizedlist>
                        </simplesect>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, change
                                directory to the Staff Client source directory, then execute the following
                                commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        </userinput>
-</screen>
+                               </screen>
                                <para>Command to build all updates at once:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        make updates
        </userinput>
-</screen>
+                               </screen>
                                <para>commands to build updates individually:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        make generic-updates
        make win-updates
        make linux-updates
        make extension-updates
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect>
                                <title>Building updates with clients</title>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, execute
                                one of the following commands:</para>
                                <para>To build all updates at once:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make updates-client
        </userinput>
-</screen>
+                               </screen>
                                <para>To build updates individually:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # 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
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect>
                                <title>Activating the Update Server</title>
                                <filename>manualupdate.html</filename>, and
                                <filename>update.rdf</filename>, as the root user execute the following
                                commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the root user:
        cd /openils/var/updates/pub
        chmod +x  check  download  manualupdate.html  update.rdf
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                </section>
                <section>
                                start menu.</para>
                                <para>As the <systemitem class="username">opensrf</systemitem> user, 
                                execute the following commands:</para>
-<screen>
-       <userinput>
+                               <screen>
+                                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
        make NSIS_EXTRAOPTS=-DPROFILES win-client
        </userinput>
-</screen>
+                               </screen>
                        </simplesect>
                        <simplesect>
                                <title> Multiple Staff Clients</title>
                <para>For example, if the source files for the Evergreen installation are in the directory 
                <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2/</filename> you can start the 
                Staff Client as shown in the following example:</para>
-<screen>
-       <userinput>
+               <screen>
+                       <userinput>
        # as the opensrf user:
        cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build
        xulrunner application.ini
        </userinput>
-</screen>
+               </screen>
                <section xml:id="staffclientinstallation-workstationnames">
                        <title>Assigning Workstation Names</title>
                        <indexterm>
                        interfaces - anything at all in the Staff Client.</para>
                        <itemizedlist>
                                <listitem>Create a new tab by pressing
-                               <keycombo>
-                                       <keycap>Ctrl</keycap>
-                                       <keycap>T</keycap>
-                               </keycombo>
+                               <keycombo><keycap>Ctrl</keycap><keycap>T</keycap></keycombo>
                                on the keyboard or selecting:
-                               <menuchoice>
-                                       <guimenu>File</guimenu>
-                                       <guimenuitem>New Tab</guimenuitem>
-                               </menuchoice>
+                               <menuchoice><guimenu>File</guimenu><guimenuitem>New Tab</guimenuitem></menuchoice>
                                from the menu.</listitem>
                                <listitem>Close a tab by pressing
-                               <keycombo>
-                                       <keycap>Ctrl</keycap>
-                                       <keycap>W</keycap>
-                               </keycombo> on the keyboard or selecting
-                               <menuchoice>
-                                       <guimenu>File</guimenu>
-                                       <guimenuitem>Close Tab</guimenuitem>
-                               </menuchoice>
+                               <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo> on the keyboard or selecting
+                               <menuchoice><guimenu>File</guimenu><guimenuitem>Close Tab</guimenuitem></menuchoice>
                                from the menu.</listitem>
                                <listitem>Switch tabs by pressing 
-                               <keycombo>
-                                       <keycap>Ctrl</keycap>
-                                       <keycap>Tab</keycap>
-                               </keycombo>
+                               <keycombo><keycap>Ctrl</keycap><keycap>Tab</keycap></keycombo>
                                on the keyboard or selecting the tab in the tab bar.</listitem>
                        </itemizedlist>
                </section>
index 5d0cc7c..94a4645 100644 (file)
Binary files a/1.6/media/serversideinstallation-staffclient-running-1.png and b/1.6/media/serversideinstallation-staffclient-running-1.png differ