Clean up a few more admin files.
authorRobert Soulliere <rsoulliere@libdog.mohawkcollege.ca>
Thu, 16 Sep 2010 12:41:54 +0000 (08:41 -0400)
committerRobert Soulliere <rsoulliere@libdog.mohawkcollege.ca>
Thu, 16 Sep 2010 12:41:54 +0000 (08:41 -0400)
1.6/admin/AdminMisc.xml
1.6/admin/Upgrading-Evergreen_1.6.xml
1.6/admin/admin-lsa.xml
1.6/admin/serveradministration.xml
1.6/admin/troubleshooting.xml

index 33f6f6e..cb66410 100644 (file)
@@ -51,7 +51,7 @@
                <indexterm><primary>web server</primary><secondary>Apache</secondary></indexterm> for the OPAC to work correctly.</para>  \r
                <para>To stop <application>Evergreen</application>, run:</para>\r
                <screen><userinput>osrf_ctl.sh -l -a stop_all</userinput></screen>\r
                <indexterm><primary>web server</primary><secondary>Apache</secondary></indexterm> for the OPAC to work correctly.</para>  \r
                <para>To stop <application>Evergreen</application>, run:</para>\r
                <screen><userinput>osrf_ctl.sh -l -a stop_all</userinput></screen>\r
-               <para>As with starting, you can choose to stop one service</para>\r
+               <para>As with starting, you can choose to stop services individually.</para>\r
                <para>To restart <application>Evergreen</application>, run:</para>\r
                <screen><userinput>osrf_ctl.sh -l -a restart_all</userinput></screen>\r
        </section>\r
                <para>To restart <application>Evergreen</application>, run:</para>\r
                <screen><userinput>osrf_ctl.sh -l -a restart_all</userinput></screen>\r
        </section>\r
@@ -67,8 +67,7 @@
                        <secondary>PostgreSQL</secondary></indexterm>  database. You can therefore use normal \r
                        <application>PostgreSQL</application> backup procedures to backup this data. For example, the simplest method of backing up the Evergreen\r
                        database is to use the <command>pg_dump</command> command to create a live backup of the database without having to \r
                        <secondary>PostgreSQL</secondary></indexterm>  database. You can therefore use normal \r
                        <application>PostgreSQL</application> backup procedures to backup this data. For example, the simplest method of backing up the Evergreen\r
                        database is to use the <command>pg_dump</command> command to create a live backup of the database without having to \r
-                       interrupt any Evergreen services:</para>\r
-                       <screen><userinput># pg_dump -U [username] -h [hostname] -f [output-file] [database-name]</userinput></screen> \r
+                       interrupt any Evergreen services. Here is an example pg_dump command which will dump a local Evergreen database into a the file <filename>evergreen_db.backup</filename>:</para>\r
                        <screen><userinput>pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen</userinput></screen>\r
                        <para>To restore the backed up database into a new database, create a new database using the \r
                        template0 database template and the UTF8 encoding, and run the <command>psql</command> command, specifying the new \r
                        <screen><userinput>pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen</userinput></screen>\r
                        <para>To restore the backed up database into a new database, create a new database using the \r
                        template0 database template and the UTF8 encoding, and run the <command>psql</command> command, specifying the new \r
index 1ef3795..a194b37 100644 (file)
                                <screen><userinput>/openils/bin/srfsh</userinput></screen>\r
                                <screen><userinput>srfsh#  request opensrf.math add 2 2</userinput></screen>\r
                                <para>You should see output like:</para>\r
                                <screen><userinput>/openils/bin/srfsh</userinput></screen>\r
                                <screen><userinput>srfsh#  request opensrf.math add 2 2</userinput></screen>\r
                                <para>You should see output like:</para>\r
-                               <screen>\r
-                               Received Data: 4\r
-                               \r
-                               ------------------------------------\r
-                               Request Completed Successfully\r
-                               Request Time in seconds: 0.007519\r
-                               ------------------------------------\r
-                               \r
-                               srfsh#\r
-                               </screen>       \r
+<screen>\r
+Received Data: 4\r
+\r
+------------------------------------\r
+Request Completed Successfully\r
+Request Time in seconds: 0.007519\r
+------------------------------------\r
+\r
+srfsh#\r
+</screen>      \r
                                <para>If test completed successfully move onto next section. \r
                                Otherwise, refer to the <link linkend="troubleshooting">troubleshooting</link> chapter \r
                                of this documentation.</para> \r
                                <para>If test completed successfully move onto next section. \r
                                Otherwise, refer to the <link linkend="troubleshooting">troubleshooting</link> chapter \r
                                of this documentation.</para> \r
                                <para>As the <systemitem class="username">root</systemitem> user, build <filename>live-db-setup.pl</filename> for the cgi-bin \r
                                bootstrapping scripts and <filename>offline-config.pl</filename> for the offline staff client data uploader:</para>\r
                                <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen>                          \r
                                <para>As the <systemitem class="username">root</systemitem> user, build <filename>live-db-setup.pl</filename> for the cgi-bin \r
                                bootstrapping scripts and <filename>offline-config.pl</filename> for the offline staff client data uploader:</para>\r
                                <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen>                          \r
-                               <screen>\r
-                               <userinput>\r
-                               perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \\r
-                               --password evergreen --hostname localhost --port 5432 --database evergreen\r
-                               </userinput>\r
-                               </screen>\r
+<screen>\r
+<userinput>\r
+perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \\r
+--password evergreen --hostname localhost --port 5432 --database evergreen\r
+</userinput>\r
+</screen>\r
                        </step>\r
                        <step>\r
                                <para>As the <systemitem class="username">opensrf</systemitem> user, update server symlink in <filename class="directory">/openils/var/web/xul/</filename>:</para>\r
                        </step>\r
                        <step>\r
                                <para>As the <systemitem class="username">opensrf</systemitem> user, update server symlink in <filename class="directory">/openils/var/web/xul/</filename>:</para>\r
@@ -249,11 +249,11 @@ psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db
                        </step>\r
                        <step>\r
                                <para>Update <filename>opensrf.xml</filename> with the database connection info:</para>\r
                        </step>\r
                        <step>\r
                                <para>Update <filename>opensrf.xml</filename> with the database connection info:</para>\r
-                               <screen>\r
-                               <userinput>\r
-                               perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \\r
-                               --password evergreen --hostname localhost --port 5432 --database evergreen\r
-                               </userinput>\r
+<screen>\r
+<userinput>\r
+perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \\r
+--password evergreen --hostname localhost --port 5432 --database evergreen\r
+</userinput>\r
                                </screen>\r
                        </step>\r
                        <step>\r
                                </screen>\r
                        </step>\r
                        <step>\r
index 6e8ee6f..d3eb019 100644 (file)
@@ -39,7 +39,7 @@
       <para>Items on this menu are visible to anyone logged into the staff client but usually\r
          require special permissions to edit. The following table describes each of the menu options. </para>\r
       <informaltable>\r
       <para>Items on this menu are visible to anyone logged into the staff client but usually\r
          require special permissions to edit. The following table describes each of the menu options. </para>\r
       <informaltable>\r
-         <tgroup cols="3" align="left" colsep="1" rowsep="1">\r
+         <tgroup cols="2" align="left" colsep="1" rowsep="1">\r
 \r
             <thead>\r
                <row>\r
 \r
             <thead>\r
                <row>\r
index c58e323..ea4af21 100644 (file)
@@ -1716,54 +1716,54 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                Create a marc template in  the directory <filename class="directory">/openils/var/templates/marc/</filename>. It should be in xml format.\r
                                Here is an example file <filename>k_book.xml</filename>: \r
                                </para>\r
                                Create a marc template in  the directory <filename class="directory">/openils/var/templates/marc/</filename>. It should be in xml format.\r
                                Here is an example file <filename>k_book.xml</filename>: \r
                                </para>\r
-                       <programlisting language="xml">\r
-                       <![CDATA[\r
-                       <record>\r
-                         <leader>00620cam a2200205Ka 4500</leader>\r
-                         <controlfield tag="008">070101s                            eng d</controlfield>\r
-                         <datafield tag="010" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="020" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="082" ind1="0" ind2="4">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="092" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="100" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="245" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="b"></subfield>\r
-                           <subfield code="c"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="260" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="b"></subfield>\r
-                           <subfield code="c"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="300" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="b"></subfield>\r
-                           <subfield code="c"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="500" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="650" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                           <subfield code="v"></subfield>\r
-                         </datafield>\r
-                         <datafield tag="650" ind1="" ind2="">\r
-                           <subfield code="a"></subfield>\r
-                         </datafield>\r
-                       </record>\r
-                       ]]>\r
-                       </programlisting>\r
+<programlisting language="xml">\r
+<![CDATA[\r
+<record>\r
+  <leader>00620cam a2200205Ka 4500</leader>\r
+  <controlfield tag="008">070101s                            eng d</controlfield>\r
+  <datafield tag="010" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="020" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="082" ind1="0" ind2="4">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="092" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="100" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="245" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="b"></subfield>\r
+    <subfield code="c"></subfield>\r
+  </datafield>\r
+  <datafield tag="260" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="b"></subfield>\r
+    <subfield code="c"></subfield>\r
+  </datafield>\r
+  <datafield tag="300" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="b"></subfield>\r
+    <subfield code="c"></subfield>\r
+  </datafield>\r
+  <datafield tag="500" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+  <datafield tag="650" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+    <subfield code="v"></subfield>\r
+  </datafield>\r
+  <datafield tag="650" ind1="" ind2="">\r
+    <subfield code="a"></subfield>\r
+  </datafield>\r
+</record>\r
+]]>\r
+</programlisting>\r
        \r
                        </step>\r
                        <step>\r
        \r
                        </step>\r
                        <step>\r
@@ -1772,7 +1772,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                        </step>\r
                        <step>\r
                                <para>Restart <systemitem class="service">Perl</systemitem><indexterm><primary>Perl</primary></indexterm> services for changes to take effect.</para>\r
                        </step>\r
                        <step>\r
                                <para>Restart <systemitem class="service">Perl</systemitem><indexterm><primary>Perl</primary></indexterm> services for changes to take effect.</para>\r
-                               <screen><userimput>/openils/bin/osrf_ctl.sh -l -a restart_perl</userimput></screen>\r
+                               <screen><userinput>/openils/bin/osrf_ctl.sh -l -a restart_perl</userinput></screen>\r
                        </step>\r
                </procedure>\r
        </section>\r
                        </step>\r
                </procedure>\r
        </section>\r
@@ -2011,47 +2011,47 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
                                <step>\r
                                        <para>Clone the title|proper index to create a keyword|title index</para>\r
                                        <para>6 = the title|proper index</para>\r
                                <step>\r
                                        <para>Clone the title|proper index to create a keyword|title index</para>\r
                                        <para>6 = the title|proper index</para>\r
-                                       <programlisting>\r
-                                       INSERT INTO config.metabib_field \r
-                                               (field_class, name, xpath, weight, format, search_field, facet_field)\r
-                                               SELECT 'keyword', 'title', xpath, weight, format, search_field, facet_field\r
-                                               FROM config.metabib_field\r
-                                               WHERE id = 6;\r
-                                       </programlisting>\r
+<programlisting>\r
+INSERT INTO config.metabib_field \r
+       (field_class, name, xpath, weight, format, search_field, facet_field)\r
+       SELECT 'keyword', 'title', xpath, weight, format, search_field, facet_field\r
+       FROM config.metabib_field\r
+       WHERE id = 6;\r
+</programlisting>\r
                                </step>\r
                                <step>\r
                                        <para>Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table;</para>\r
                                        <para>6 = the title|proper index</para>\r
                                </step>\r
                                <step>\r
                                        <para>Populate the keyword|title index with a set of index entries cloned from the metabib.title_field_entry table;</para>\r
                                        <para>6 = the title|proper index</para>\r
-                                       <programlisting>\r
-                                       INSERT INTO metabib.keyword_field_entry \r
-                                               (source, field, value)\r
-                                               SELECT source, 17, value (the field value, 17, field be different in your database so you may need to check the \r
-                                               <link linkend="config.metabib_field">config.metabib_field</link> for the id of your new index).\r
-                                               FROM metabib.title_field_entry\r
-                                               WHERE field = 6;\r
-                                       </programlisting>\r
+<programlisting>\r
+INSERT INTO metabib.keyword_field_entry \r
+       (source, field, value)\r
+       SELECT source, 17, value (the field value, 17, field be different in your database so you may need to check the \r
+       <link linkend="config.metabib_field">config.metabib_field</link> for the id of your new index).\r
+       FROM metabib.title_field_entry\r
+       WHERE field = 6;\r
+</programlisting>\r
                                </step>\r
                                <step> \r
                                        <para>Bump the relevance when the first search term appears first in the title in a keyword search.</para>\r
                                        <para>17 = our new keyword|title index (This may be different in your database so you may need to check the \r
                                        <link linkend="config.metabib_field">config.metabib_field</link> for the id \r
                                        of your new index).</para>\r
                                </step>\r
                                <step> \r
                                        <para>Bump the relevance when the first search term appears first in the title in a keyword search.</para>\r
                                        <para>17 = our new keyword|title index (This may be different in your database so you may need to check the \r
                                        <link linkend="config.metabib_field">config.metabib_field</link> for the id \r
                                        of your new index).</para>\r
-                                       <programlisting>\r
-                                       INSERT INTO search.relevance_adjustment \r
-                                               (active, field, bump_type, multiplier)\r
-                                       VALUES (true, 17, 'first_word', 5); \r
-                                       </programlisting>\r
+<programlisting>\r
+INSERT INTO search.relevance_adjustment \r
+       (active, field, bump_type, multiplier)\r
+VALUES (true, 17, 'first_word', 5); \r
+</programlisting>\r
                                </step>\r
                                <step>\r
                                        <para>Boost the relevance for search terms appearing in the title in general</para>\r
                                        <para>17 = our new keyword|title index (This may be different in your database so you may need to check the \r
                                        <link linkend="config.metabib_field">config.metabib_field</link> for the id \r
                                        of your new index).</para>\r
                                </step>\r
                                <step>\r
                                        <para>Boost the relevance for search terms appearing in the title in general</para>\r
                                        <para>17 = our new keyword|title index (This may be different in your database so you may need to check the \r
                                        <link linkend="config.metabib_field">config.metabib_field</link> for the id \r
                                        of your new index).</para>\r
-                                       <programlisting>\r
-                                       UPDATE config.metabib_field\r
-                                       SET weight = 10\r
-                                       WHERE id = 17;\r
-                                       </programlisting>\r
+<programlisting>\r
+UPDATE config.metabib_field\r
+SET weight = 10\r
+WHERE id = 17;\r
+</programlisting>\r
                                </step>\r
                        </procedure>  \r
                </simplesect> \r
                                </step>\r
                        </procedure>  \r
                </simplesect> \r
index 99b46c6..b354d99 100644 (file)
@@ -184,10 +184,10 @@ srfsh#</screen>
                        <para>or</para>\r
                        <screen>apache2ctl start</screen>\r
                        <para>You should see output:</para>\r
                        <para>or</para>\r
                        <screen>apache2ctl start</screen>\r
                        <para>You should see output:</para>\r
-                       <screen>\r
-                       * Starting web server apache2\r
-                       ...done.\r
-                       </screen>\r
+<screen>\r
+* Starting web server apache2\r
+...done.\r
+</screen>\r
                        <para>the Apache OpenSRF modules write to the \r
                        <filename>/openils/var/log/gateway.log</filename></para><indexterm><primary>logs</primary><secondary>gateway.log</secondary></indexterm>\r
                        <para>However, you should check all of the log files for errors:</para>\r
                        <para>the Apache OpenSRF modules write to the \r
                        <filename>/openils/var/log/gateway.log</filename></para><indexterm><primary>logs</primary><secondary>gateway.log</secondary></indexterm>\r
                        <para>However, you should check all of the log files for errors:</para>\r