[LON-CAPA-cvs] cvs: doc /build RHEL5_install.frag suse10.3_install.frag

bisitz bisitz@source.lon-capa.org
Mon, 07 Sep 2009 14:56:19 -0000


This is a MIME encoded message

--bisitz1252335379
Content-Type: text/plain

bisitz		Mon Sep  7 14:56:19 2009 EDT

  Modified files:              
    /doc/build	suse10.3_install.frag RHEL5_install.frag 
  Log:
  Optimized overview and navigation in installation guides:
  - Added links in overview which point to the main steps
  - Added numbering to main step headlines (corresponding to numbering in overview)
  - Added two <hr> to separate main steps from header and footer
  - Removed some trailing blanks
  
  (Thanks to Jannis Ohms)
  
  
--bisitz1252335379
Content-Type: text/plain
Content-Disposition: attachment; filename="bisitz-20090907145619.txt"

Index: doc/build/suse10.3_install.frag
diff -u doc/build/suse10.3_install.frag:1.3 doc/build/suse10.3_install.frag:1.4
--- doc/build/suse10.3_install.frag:1.3	Wed Dec 10 19:57:29 2008
+++ doc/build/suse10.3_install.frag	Mon Sep  7 14:56:19 2009
@@ -1,36 +1,41 @@
 <h1>Installing LON-CAPA on a minimal SuSE Linux 10.3 System</h1>
 <p>
 This document guides you through the process of setting up a new LON-CAPA
-server running SuSE Linux 10.3 with a minimum of packages installed.  
-The computer will be configured solely as a LON-CAPA server and will be 
+server running SuSE Linux 10.3 with a minimum of packages installed.
+The computer will be configured solely as a LON-CAPA server and will be
 expected to have no other services running.  Your server is expected to have a reasonably fast connection to the internet.
 </p><p>
-More information is available at 
+More information is available at
 <a href="http://install.lon-capa.org/">http://install.lon-capa.org/</a>.
 </p>
+
 <h2>Before you begin</h2>
 <p>
 Installing Linux is getting easier and easier. You will be required to log in to the machine and execute some routine Unix commands.  Familiarity with the Apache web server, mod_perl, perl, and MySQL are not required to install and run LON-CAPA.
 </p>
+
 <h2>Installation Overview</h2>
 <p>
 The installation process takes the following steps:
 </p>
 <ol>
-  <li> Obtain SuSE 10.3 installation media (DVD, or CD)</li>
-  <li> Determine Network Settings</li>
-  <li> Install Suse 10.3</li>
-  <li> Update your system</li>
-  <li> Install LON-CAPA</li>
-  <li> Create a Domain Coordinator</li>
-  <li> Start/Restart services</li>
-  <li> Log in to LON-CAPA</li>
+  <li><a href="#obt">Obtain SuSE 10.3 installation media (DVD, or CD)</a></li>
+  <li><a href="#net">Determine Network Settings</a></li>
+  <li><a href="#lin">Install Suse 10.3</a></li>
+  <li><a href="#upd">Update your system</a></li>
+  <li><a href="#ilc">Install LON-CAPA</a></li>
+  <li><a href="#cdc">Create a Domain Coordinator</a></li>
+  <li><a href="#sts">Start/Restart services</a></li>
+  <li><a href="#log">Log in to LON-CAPA</a></li>
 </ol>
-<h2>Obtain SuSE Linux 10.3</h2>
+<hr />
+
+<h2>1. <a name="obt">Obtain SuSE Linux 10.3</a></h2>
 <p>
 A SuSE 10.3 iso for burning to DVD can be obtained from the opensuse download site: <a href="http://software.opensuse.org/">http://http://software.opensuse.org/</a>, or from an opensuse mirror site - <a href="http://en.opensuse.org/Mirrors_Released_Version">http://en.opensuse.org/Mirrors_Released_Version</a>.  You will also find links there to sites with iso files for burning a Start-CD-Image (a mini.iso) used in a network install, if burning a CD is more convenient for you.
-</p> 
-<h2>Determine Network Settings</h2>
+</p>
+
+<h2>2. <a name="net">Determine Network Settings</a></h2>
 <p>
 You will need to know the following network settings for your installation.
 <b>Note:</b>You must have a static IP address to use LON-CAPA.
@@ -43,10 +48,11 @@
   <li>gateway </li>
   <li>domain name server(s) </li>
 </ul>
-<h2>Minimal SuSE 10.3 Install</h2>
+
+<h2>3. <a name="lin">Minimal SuSE 10.3 Install</a></h2>
 <p>
 Installing SuSE 10.3 is quite easy if you've installed Linux products
-before.  Some documentation is available from 
+before.  Some documentation is available from
 <a href="http://en.opensuse.org/INSTALL_Local">
 http://en.opensuse.org/INSTALL_Local</a> for installations from DVD and
 <a href="http://en.opensuse.org/INSTALL_Internet">http://en.opensuse.org/INSTALL_Internet</a> for installations via the network, booting from the mini.iso CD.<br /><br />
@@ -61,19 +67,19 @@
    <dt>Software Selection</dt>
    <dd>Choose Expert Mode and for Software enable Base System, Yast Installation Packages and Software Management</dd>
    <dt>Partitioning your Drive</dt>
-   <dd>For a LON-CAPA library server (i.e., the main server used 
-       for permanent storage of course and user data), 
-       a separate partition is recommended for /home, as this    
+   <dd>For a LON-CAPA library server (i.e., the main server used
+       for permanent storage of course and user data),
+       a separate partition is recommended for /home, as this
        simplifies future upgrades of the operating system.
-       If you are adding an additional access server to an 
-       existing LON-CAPA domain, this does not apply as no 
+       If you are adding an additional access server to an
+       existing LON-CAPA domain, this does not apply as no
        permenent data are stored on an access server.
        As LON-CAPA resource files are stored in the /home directory,
        the majority of the disk space should be allocated here.
-       If you have 20 GB of space for SuSE 10.3, /home should 
-       receive at least 10 to 12 gigs. Since MySQL uses the /var 
-       filesystem to store its databases you should have as least 
-       4 gigs of space available on /var.  Be sure to 
+       If you have 20 GB of space for SuSE 10.3, /home should
+       receive at least 10 to 12 gigs. Since MySQL uses the /var
+       filesystem to store its databases you should have as least
+       4 gigs of space available on /var.  Be sure to
        include adequate swap space.  A minimum is 512 Megs, but you should
        typically have 1 or 2x as much swap space as you do physical RAM.
        </dd>
@@ -96,7 +102,8 @@
 and let you configure any extra hardware, and then finish up the boot
 process. At the prompt login as root.
 </p>
-<h2>Change software sources for your system</h2>
+
+<h2>4. <a name="upd">Change software sources for your system</a></h2>
 <p>If you do not already have a SuSE 10.3 installation source at your location, you may want to consider creating one from the iso file for the DVD. Proceed as follows (e.g., for 32 bit):</p>
 <pre>
 mkdir -p suse103/DVD
@@ -127,9 +134,10 @@
 <dd>Authentication</dd>
 <dt>Anonymous</dt>
 </dl>
-After saving this configuration information for the LON-CAPA repository, you will need to import a public LON-CAPA key, before the catalog is read, and the repository is available to you. Quit yast.    
+After saving this configuration information for the LON-CAPA repository, you will need to import a public LON-CAPA key, before the catalog is read, and the repository is available to you. Quit yast.
 </p>
-<h2>Installing LON-CAPA</h2>
+
+<h2>5. <a name="ilc">Installing LON-CAPA</a></h2>
 <h3>Install prerequisites</h3>
 <p> Execute: </p>
 <pre>
@@ -171,23 +179,23 @@
   <dd>The server must be designated a 'library' or an 'access' server.  In
       general you should have a library server for your instructors to create
       their course content on and run their courses.  Students should connect
-      to access servers.  If you are doing the first install of LON-CAPA at 
+      to access servers.  If you are doing the first install of LON-CAPA at
       your site, or if you are playing with it for your own edification you
       should make your machine a 'library' server.</dd>
   <dt>LON-CAPA domain</dt>
   <dd>Each site or school which installs LON-CAPA needs its own domain.
       Here at MSU we use 'msu'.  You should choose something short but
-      meaningful.  <i>Restriction: One word, no hyphens, underscores, or 
+      meaningful.  <i>Restriction: One word, no hyphens, underscores, or
       special characters.</i>
   </dd>
   <dt>LON-CAPA host id</dt>
   <dd>Each LON-CAPA server requires a unique internal name.  We use names
-      such as "msul1" for the first library server. <i>Restriction: One word, 
+      such as "msul1" for the first library server. <i>Restriction: One word,
       no hyphens, underscores, or special characters.</i>
   </dd>
   <dt>Host administrator email</dt>
   <dd>The amount of email sent to this address is relatively minimal.  Messages
-      are sent every time the system starts up, or if the system is in 
+      are sent every time the system starts up, or if the system is in
       serious trouble. On a laptop, make this <tt>root@localhost</tt>.
   </dd>
 </dl>
@@ -201,17 +209,18 @@
 ./UPDATE
 </pre>
 <p>
-You will need to enter the LON-CAPA configuration information you determined 
-in the previous section.  
+You will need to enter the LON-CAPA configuration information you determined
+in the previous section.
 </p>
-<h2>Creating a Domain Coordinator</h2>
+
+<h2>6. <a name="cdc">Creating a Domain Coordinator</a></h2>
 <p>
 You will need at least one user at your site who has the role of
 'domain coordinator'.  This user creates accounts for other users and
 grants them additional privileges.  The make_domain_coordinator.pl script
 invoked below requires that you enter the users password.  The password will
 show in plaintext as you type it.  Feel free to use the "passwd username"
-command to change it later.  Replace USERNAME and DOMAIN with an 
+command to change it later.  Replace USERNAME and DOMAIN with an
 appropriate user name and your domain.
 </p>
 <pre>
@@ -219,7 +228,8 @@
 perl make_domain_coordinator.pl USERNAME DOMAIN
 (WILL PROMPT FOR PASSWORD HERE)
 </pre>
-<h2>Start/Restart Services</h2>
+
+<h2>7. <a name="sts">Start/Restart Services</a></h2>
 <p>
 The LON-CAPA network services take a moment to start.  Most misconfigurations
 will be apparent at this step.
@@ -230,15 +240,18 @@
 </pre>
 <p>
 If you receive warnings about missing perl modules when starting apache2,
-please make sure you followed the instructions in 
+please make sure you followed the instructions in
 <b>Installing LON-CAPA Dependencies</b>.  If you still have errors, please
 contact the MSU LON-CAPA group.
 </p>
-<h2>Log in to your LON-CAPA Machine</h2>
+
+<h2>8. <a name="log">Log in to your LON-CAPA Machine</a></h2>
 <p>
 Point a web browser at your new machine and log in as the domain
 coordinator.  Congratulations!
 </p>
+
+<hr />
 <h2>If things aren't working right</h2>
 <p>
 If you've followed the steps above and the server doesn't start or you think
@@ -246,6 +259,6 @@
 You can submit a help request using our web form:<br />
 <a href="http://help.loncapa.org/help/">http://help.loncapa.org/help/</a><br />
 If there were errors in installation of the dependency RPMs or during the
-automatic setup, please send us as much information as possible. 
+automatic setup, please send us as much information as possible.
 Please let us know if any parts of this document are unclear.
 </p>
Index: doc/build/RHEL5_install.frag
diff -u doc/build/RHEL5_install.frag:1.4 doc/build/RHEL5_install.frag:1.5
--- doc/build/RHEL5_install.frag:1.4	Wed Dec 10 19:57:29 2008
+++ doc/build/RHEL5_install.frag	Mon Sep  7 14:56:19 2009
@@ -1,12 +1,12 @@
 <h1>Installing LON-CAPA on a minimal Red Hat Enterprise Linux 5 System</h1>
 <p>
 This document guides you through the process of setting up a new LON-CAPA
-server running Red Hat Enterprise Linux 5 with a minimum of packages installed.  
-The computer will be configured solely as a LON-CAPA server and will be 
+server running Red Hat Enterprise Linux 5 with a minimum of packages installed.
+The computer will be configured solely as a LON-CAPA server and will be
 expected to have no other services running.  Your server is expected to have
 a reasonably fast connection to the internet.
 </p><p>
-More information is available at 
+More information is available at
 <a href="http://install.lon-capa.org/">http://install.lon-capa.org/</a>.
 </p>
 
@@ -14,7 +14,7 @@
 <p>
 Installing Linux is getting easier and easier.
 You will be required to log in to the machine and execute
-some routine Unix commands.  Familiarity with the Apache web server, mod_perl, 
+some routine Unix commands.  Familiarity with the Apache web server, mod_perl,
 perl, and MySQL are not required to install and run LON-CAPA.
 </p>
 
@@ -23,28 +23,28 @@
 The installation process takes the following steps:
 </p>
 <ol>
-  <li> Obtain Red Hat Enterprise Linux 5 installation CDs</li>
-  <li> Determine Network Settings</li>
-  <li> Install Red Hat Enterprise Linux 5 </li>
-  <li> Update your system </li>
-  <li> Install LON-CAPA </li>
-  <li> Create a Domain Coordinator </li>
-  <li> Start/Restart services </li>
-  <li> Log in to LON-CAPA </li>
+  <li><a href="#obt">Obtain Red Hat Enterprise Linux 5 installation CDs</a></li>
+  <li><a href="#net">Determine Network Settings</a></li>
+  <li><a href="#lin">Install Red Hat Enterprise Linux 5</a></li>
+  <li><a href="#upd">Update your system</a></li>
+  <li><a href="#ilc">Install LON-CAPA</a></li>
+  <li><a href="#cdc">Create a Domain Coordinator</a></li>
+  <li><a href="#sts">Start/Restart services</a></li>
+  <li><a href="#log">Log in to LON-CAPA</a></li>
 </ol>
-
-<h2>Obtain Red Hat Enterprise Linux 5 CDs</h2>
+<hr />
+<h2>1. <a name="obt">Obtain Red Hat Enterprise Linux 5 CDs</a></h2>
 <p>
-RHEL5 CDs can be purchased from Red Hat:  
+RHEL5 CDs can be purchased from Red Hat:
 <a href="http://redhat.com/">http://redhat.com/</a>.
 For the minimal install on 32-bit architecture you will need only the first CD.
 For the minimal install on 64-bit architecture you will need CDs 1, 2, and 4.
 
-</p> 
+</p>
 
-<h2>Determine Network Settings</h2>
+<h2>2. <a name="net">Determine Network Settings</a></h2>
 <p>
-You will need to know the following network settings for your installation.  
+You will need to know the following network settings for your installation.
 <b>Note:</b>You must have a static IP address to use LON-CAPA.
 DHCP is <em>not</em> supported.
 
@@ -56,13 +56,13 @@
   <li>domain name server(s) </li>
 </ul>
 
-<h2>Minimal  Red Hat Enterprise Linux 5 Install</h2>
+<h2>3. <a name="lin">Minimal  Red Hat Enterprise Linux 5 Install</a></h2>
 <p>
 Installing Red Hat Enterprise Linux is quite easy if you've installed any of the Red Hat products
 before. Documentation is available from
 <a href="http://www.redhat.com/docs/manuals/enterprise/">
 http://www.redhat.com/docs/manuals/enterprise/</a>
-Most of the installation screens are self explanatory.  
+Most of the installation screens are self explanatory.
 There are a few steps that require comment and are dealt with below.
 </p>
 <dl style="list-style:square outside none">
@@ -75,15 +75,15 @@
    <dd>For a fresh install may want to use the automatic partitioning feature of the installer,
        however you should review the results and be prepared to modify them.  If you want to customize partitioning use "Create Custom Layout".
        LON-CAPA resource files are stored in the /home directory, so the
-       majority of the disk space should be allocated here.  If you have 20 GB 
-       of space for RHEL, /home should receive at least 10 to 12 gigs.  
+       majority of the disk space should be allocated here.  If you have 20 GB
+       of space for RHEL, /home should receive at least 10 to 12 gigs.
        Since MySQL uses the /var filesystem to store its databases you should
-       have at least 4 gigs of space available on /var.  Be sure to 
+       have at least 4 gigs of space available on /var.  Be sure to
        include adequate swap space.  A minimum is 512 Megs, but you should
        typically have 1 or 2x as much swap space as you do physical RAM.</dd>
 
    <dt>Network Configuration</dt>
-   <dd>LON-CAPA will <b>not</b> work with a machine set up to use a dynamic 
+   <dd>LON-CAPA will <b>not</b> work with a machine set up to use a dynamic
        IP address.  When configuring your network card, be sure to unselect
        the DHCP option and enter in your network information.</dd>
    <dt>Software</dt>
@@ -106,11 +106,11 @@
        loncontrol startup script should open and close thos ports
        itself.)
    </dd>
-   <dd> Set SELinux to Disabled.</dd>   
+   <dd> Set SELinux to Disabled.</dd>
    <dd> Select OK, and then Quit</dd>
 </p>
 
-<h2>Update your system</h2>
+<h2>4. <a name="upd">Update your system</a></h2>
 <p>
 Update your system to the latest versions of the system software using yum.
 </p>
@@ -136,7 +136,7 @@
 yum update
 </pre>
 </p>
-<h2>Installing LON-CAPA</h2>
+<h2>5. <a name="ilc">Installing LON-CAPA</a></h2>
 <h3>Install prerequisites</h3>
 <p> Execute: </p>
 <pre>
@@ -192,36 +192,36 @@
   <dd>The server must be designated a 'library' or an 'access' server.  In
       general you should have a library server for your instructors to create
       their course content on and run their courses.  Students should connect
-      to access servers.  If you are doing the first install of LON-CAPA at 
+      to access servers.  If you are doing the first install of LON-CAPA at
       your site, or if you are playing with it for your own edification you
       should make your machine a 'library' server.</dd>
   <dt>LON-CAPA domain</dt>
   <dd>Each site or school which installs LON-CAPA needs its own domain.
       Here at MSU we use 'msu'.  You should choose something short but
-      meaningful.  <i>Restriction: One word, no hyphens, underscores, or 
-      special characters.</i><br />Domain names which include a departmental 
+      meaningful.  <i>Restriction: One word, no hyphens, underscores, or
+      special characters.</i><br />Domain names which include a departmental
       abbreviation are not recommended as although LON-CAPA may start in
       a single department, other departments frequently join subsequently.
       For a domain name: 'msu' is a superior choice to 'msuphys' for example.
   </dd>
   <dt>LON-CAPA host id</dt>
   <dd>Each LON-CAPA server requires a unique internal name.  We use names
-      such as "msul1" for the first library server. <i>Restriction: One word, 
+      such as "msul1" for the first library server. <i>Restriction: One word,
       no hyphens, underscores, or special characters.</i>
   </dd>
   <dt>Domain's Primary Library Server ID</dt>
    <dd>If you are setting up a domain with a single library server, then the domain's primary library server ID will be the LON-CAPA host id of that server (e.g., msul1). Once your domain grows and you need to add more servers, one of the library servers in the domain should be assigned as the domain's primary library server.  This will be where domain-wide settings will be stored.<dd>
   <dt>Host administrator email</dt>
   <dd>The amount of email sent to this address is relatively minimal.  Messages
-      are sent every time the system starts up, or if the system is in 
+      are sent every time the system starts up, or if the system is in
       serious trouble. On a laptop, make this <tt>root@localhost</tt>.
   </dd>
   <dt>Support email address</dt>
-  <dd>If you enter an e-mail address here, then users of the system  
-      will be able to click an "Ask Helpdesk" link in the system to 
+  <dd>If you enter an e-mail address here, then users of the system
+      will be able to click an "Ask Helpdesk" link in the system to
       display a web form which they will complete to request support from
-      your institution's helpdesk. On form submission the contents 
-      will be sent to the e-mail address you specify. 
+      your institution's helpdesk. On form submission the contents
+      will be sent to the e-mail address you specify.
   </dd>
 </dl>
 
@@ -234,18 +234,18 @@
 ./UPDATE
 </pre>
 <p>
-You will need to enter the LON-CAPA configuration information you determined 
-in the previous section.  
+You will need to enter the LON-CAPA configuration information you determined
+in the previous section.
 </p>
 
-<h2>Creating a Domain Coordinator</h2>
+<h2>6. <a name="cdc">Creating a Domain Coordinator</a></h2>
 <p>
 You will need at least one user at your site who has the role of
 'domain coordinator'.  This user creates accounts for other users and
 grants them additional privileges.  The make_domain_coordinator.pl script
 invoked below requires that you enter the users password.  The password will
 show in plaintext as you type it.  Feel free to use the "passwd username"
-command to change it later.  Replace USERNAME and DOMAIN with an 
+command to change it later.  Replace USERNAME and DOMAIN with an
 appropriate user name and your domain.
 </p>
 <pre>
@@ -254,7 +254,7 @@
 (WILL PROMPT FOR PASSWORD HERE)
 </pre>
 
-<h2>Start/Restart Services</h2>
+<h2>7. <a name="sts">Start/Restart Services</a></h2>
 <p>
 The LON-CAPA network services take a moment to start.  Most misconfigurations
 will be apparent at this step.
@@ -265,19 +265,20 @@
 </pre>
 <p>
 If you receive warnings when starting the httpd about missing perl modules,
-please make sure you followed the instructions in 
+please make sure you followed the instructions in
 <b>Installing LON-CAPA Dependencies</b>.  If you still have errors, please
 contact the MSU LON-CAPA group.
 </p>
-<h2>Log in to your LON-CAPA Machine</h2>
+<h2>8. <a name="log">Log in to your LON-CAPA Machine</a></h2>
 <p>
 Point a web browser at your new machine and log in as the domain
 coordinator.  Congratulations!
 </p>
 
+<hr />
 <h2>If things aren't working right</h2>
 <p>
-If you've followed the steps above and the server doesn't start or you think 
+If you've followed the steps above and the server doesn't start or you think
 there's something wrong, please send a <a href="http://help.loncapa.org/help">help request</a> to the MSU LON-CAPA group.  If there were errors in installation of the dependency RPMs or errors during the
 automatic setup, please send us as much information as possible.
 If some part of this document is unclear please let us know.

--bisitz1252335379--