Annotation of doc/build/RHEL6_install.frag, revision 1.7

1.1       raeburn     1: <h1>Installing LON-CAPA on a minimal Red Hat Enterprise Linux 6 System</h1>
                      2: <p>
                      3: This document guides you through the process of setting up a new LON-CAPA
                      4: server running Red Hat Enterprise Linux 6 with a minimum of packages installed.
                      5: The computer will be configured solely as a LON-CAPA server and will be
                      6: expected to have no other services running.  Your server is expected to have
                      7: a reasonably fast connection to the internet.
                      8: </p><p>
                      9: More information is available at
                     10: <a href="http://install.lon-capa.org/">http://install.lon-capa.org/</a>.
                     11: </p>
                     12: 
                     13: <h2>Before you begin</h2>
                     14: <p>
                     15: Installing Linux is getting easier and easier.
                     16: You will be required to log in to the machine and execute
                     17: some routine Unix commands.  Familiarity with the Apache web server, mod_perl,
                     18: perl, and MySQL are not required to install and run LON-CAPA.
                     19: </p>
                     20: 
                     21: <h2>Installation Overview</h2>
                     22: <p>
                     23: The installation process takes the following steps:
                     24: </p>
                     25: <ol>
                     26:   <li><a href="#obt">Obtain Red Hat Enterprise Linux 6 installation CDs</a></li>
                     27:   <li><a href="#net">Determine Network Settings</a></li>
                     28:   <li><a href="#lin">Install Red Hat Enterprise Linux 6</a></li>
                     29:   <li><a href="#upd">Update your system</a></li>
                     30:   <li><a href="#ilc">Install LON-CAPA</a></li>
                     31:   <li><a href="#cdc">Create a Domain Coordinator</a></li>
                     32:   <li><a href="#sts">Start/Restart services</a></li>
                     33:   <li><a href="#log">Log in to LON-CAPA</a></li>
                     34: </ol>
1.4       bisitz     35: 
                     36: <hr>
1.1       raeburn    37: <h2>1. <a name="obt">Obtain Red Hat Enterprise Linux 6 CDs</a></h2>
                     38: <p>
                     39: RHEL6 CDs can be purchased from Red Hat:
                     40: <a href="http://redhat.com/">http://redhat.com/</a>.
                     41: For the minimal install on 32-bit architecture you will need only the first CD.
                     42: For the minimal install on 64-bit architecture you will need CDs 1, 2, and 4.
                     43: </p>
                     44: 
                     45: <h2>2. <a name="net">Determine Network Settings</a></h2>
                     46: <p>
                     47: You will need to know the following network settings for your installation.
                     48: <b>Note:</b>You must have a static IP address to use LON-CAPA.
                     49: DHCP is <em>not</em> supported.
                     50: 
                     51: <ul>
                     52:   <li>ip address </li>
                     53:   <li>netmask </li>
                     54:   <li>hostname </li>
                     55:   <li>gateway </li>
                     56:   <li>domain name server(s) </li>
                     57: </ul>
                     58: 
                     59: <h2>3. <a name="lin">Minimal  Red Hat Enterprise Linux 6 Install</a></h2>
                     60: <p>
                     61: Installing Red Hat Enterprise Linux is quite easy if you've installed any of the Red Hat products
                     62: before. Documentation is available from
                     63: <a href="http://www.redhat.com/docs/manuals/enterprise/">
                     64: http://www.redhat.com/docs/manuals/enterprise/</a>
                     65: Most of the installation screens are self explanatory.
                     66: There are a few steps that require comment and are dealt with below.
                     67: </p>
                     68: <dl style="list-style:square outside none">
                     69:    <dt>Installation Language</dt>
                     70:    <dd>Use English as your installation language.</dd>
                     71:    <dt>Installation Type</dt>
                     72:    <dd>If this is a fresh install choose "Install Red Hat Enterprise Linux Server". If updating from a previous LON-CAPA installation on an earlier Redhat or Fedora version you may prefer to choose the upgrade option, although if you established a separate partition for /home it will be faster to perform an install instead of an upgrade, and use "Create Custom Layout" to set up partitions - making sure to select the "unchanged data" option for the /home partition, in order to preserve your existing LON-CAPA data. A full back-up to tape or some external system is also strongly advised when updating the operating system in use on an existing LON-CAPA server.</dd>
                     73: 
                     74:    <dt>Partitioning your Drive</dt>
                     75:    <dd>For a fresh install may want to use the automatic partitioning feature of the installer,
                     76:        however you should review the results and be prepared to modify them.  If you want to customize partitioning use "Create Custom Layout".
                     77:        LON-CAPA resource files are stored in the /home directory, so the
                     78:        majority of the disk space should be allocated here.  If you have 20 GB
                     79:        of space for RHEL, /home should receive at least 10 to 12 gigs.
                     80:        Since MySQL uses the /var filesystem to store its databases you should
                     81:        have at least 4 gigs of space available on /var.  Be sure to
                     82:        include adequate swap space.  A minimum is 512 Megs, but you should
                     83:        typically have 1 or 2x as much swap space as you do physical RAM.</dd>
                     84: 
                     85:    <dt>Network Configuration</dt>
                     86:    <dd>LON-CAPA will <b>not</b> work with a machine set up to use a dynamic
                     87:        IP address.  When configuring your network card, be sure to unselect
                     88:        the DHCP option and enter in your network information.</dd>
                     89:    <dt>Software</dt>
                     90:    <dd>Click the "Customize Now" radio button and for a minimal install uncheck all packages except "Base" in the Base System category.  If you leave other packages checked in any of the other categories, you'll need additional ISO CDs.</dd>
                     91: </dl>
                     92: <p>
                     93: Finish installing your server, reboot it, and log in as root. The
                     94: first time you log-in, the Setup Agent will be displayed. (If you exit it early you can enter it again buy running the command
1.4       bisitz     95: </p>
1.1       raeburn    96: <pre>
                     97: setup
                     98: </pre>
1.4       bisitz     99: <h3>Firewall and SELinux Configuration</h3>
                    100: <p>
                    101: This tool should be used to configure the Firewall and SELinux.
1.1       raeburn   102: </p>
1.4       bisitz    103: <ol>
                    104:   <li>Select Security Level: Enabled, and Customize, to allow
                    105:       incoming: SSH (remote login), WWW (HTTP) and secure WWW
                    106:       (HTTPS).
                    107:   </li>
                    108:   <li>Set SELinux to Disabled.</li>
                    109:   <li>Select OK, and then Quit</li>
                    110: </ol>
1.1       raeburn   111: 
                    112: <h2>4. <a name="upd">Update your system</a></h2>
                    113: <p>
1.6       raeburn   114: Enable access to the EPEL repository
                    115: </p>
                    116: <pre>
                    117: yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-6.noarch.rpm
                    118: </pre>
                    119: <p>
1.1       raeburn   120: Update your system to the latest versions of the system software using yum.
                    121: </p>
                    122: <pre>
                    123: yum update
                    124: </pre>
                    125: <p>
                    126: Reboot your system before continuing with the installation.
                    127: </p>
                    128: <p>
                    129: Retrieve the rhel6_loncapa_yum file from the LON-CAPA install site:
                    130: </p>
                    131: <pre>
                    132: wget http://install.loncapa.org/versions/redhat/6Server/rhel6_loncapa_yum.conf
                    133: </pre>
                    134: <p>
                    135: Install the rhel6_loncapa_yum.conf
                    136: </p>
                    137: <pre>
                    138: mv /etc/yum.conf /etc/yum.conf.backup
                    139: cp rhel6_loncapa_yum.conf /etc/yum.conf
                    140: yum update
                    141: </pre>
1.6       raeburn   142: <p>
                    143: Verify the required repositories are enabled:
                    144: </p>
                    145: <pre>
                    146: yum repolist enabled
                    147: </pre>
                    148: <p>
                    149: The list of enabled repos should be as follows (where $basearch = x86_64 or i386):
                    150: </p>
                    151: <table style="border: 0px; border-collapse: collapse;">
                    152: <tr><th>repo id</th><th>repo name</th></tr>
                    153: <tr><td>epel</td><td>Extra Packages for Enterprise Linux 6 - $basearch</td></tr>
                    154: <tr><td>loncapa-updates-basearch</td><td>RHEL 6Server LON-CAPA $basearch Updates</td></tr>
                    155: <tr><td>loncapa-updates-noarch</td><td>RHEL 6Server LON-CAPA noarch Updates</td></tr>
1.7     ! raeburn   156: <tr><td>rhel-$basearch-server-6 </td><td>Red Hat Enterprise Linux Server (v. 6 for $basearch)<td></tr>
        !           157: <tr><td>rhel-$basearch-server-optional-6</td><td>RHEL Server Optional (v. 6 $basearch)</td></tr>
1.6       raeburn   158: </table>
1.1       raeburn   159: <h2>5. <a name="ilc">Installing LON-CAPA</a></h2>
                    160: <h3>Install prerequisites</h3>
                    161: <p> Execute: </p>
                    162: <pre>
                    163: yum install LONCAPA-prerequisites
                    164: </pre><p>
1.3       raeburn   165: This may take some minutes due to LON-CAPA's large number of dependencies.
1.1       raeburn   166: </p>
                    167: <h3>Retrieve and execute LON-CAPA setup program</h3>
                    168: <p>
                    169: Retrieve the LON-CAPA setup with the following command:
                    170: </p>
                    171: <pre>
1.3       raeburn   172: wget http://install.loncapa.org/linux/install.tar
1.1       raeburn   173: </pre>
                    174: <p>
                    175: Extract the archive with the following command:
                    176: </p>
                    177: <pre>
1.3       raeburn   178: tar xf install.tar
1.1       raeburn   179: </pre>
                    180: <p>
                    181: This creates a directory named <tt>installation</tt>.  Change to it and
                    182: execute the setup script with the following commands:
                    183: </p>
                    184: <pre>
                    185: cd installation
                    186: ./install.pl
                    187: </pre>
                    188: <p>
1.2       raeburn   189: The script is used to prepare a Linux system to run LON-CAPA, and can also be
                    190: used to check the configuration of a system on which LON-CAPA has already been installed.  Typically, though, you will run this script only once, when you first install LON-CAPA.
                    191: </p>
                    192: <p>
                    193: The script will analyze your system to determine which actions are recommended.  The script will then prompt you to choose the actions you would like taken.
                    194: Once a choice has been entered for all nine possible actions, required changes will be made.
                    195: </p>
1.5       bisitz    196: <p>The possible actions are:</p>
1.1       raeburn   197: <ul>
1.2       raeburn   198: <li>Create the www user/group</li>
                    199: <li>Install the package LON-CAPA uses to authenticate users.</li>
                    200: <li>Set-up the MySQL database</li>
                    201: <li>Set-up MySQL permissions</li>
                    202: <li>Configure Apache web server</li>
                    203: <li>Configure start-up of services</li>
                    204: <li>Check firewall settings</li>
                    205: <li>Stop services not used by LON-CAPA,  e.g., services for a print server: cups daemon</li> 
                    206: <li>Download LON-CAPA source code in readiness for installation</li>
1.1       raeburn   207: </ul>
                    208: <h3>Determine LON-CAPA Settings</h3>
                    209: <p>
                    210: LON-CAPA requires a number of identifying parameters to be set in order
                    211: for it to function at all.  Below is a list with descriptions.
                    212: </p>
                    213: <dl>
                    214:   <dt>Host Type (library or access)</dt>
                    215:   <dd>The server must be designated a 'library' or an 'access' server.  In
                    216:       general you should have a library server for your instructors to create
                    217:       their course content on and run their courses.  Students should connect
                    218:       to access servers.  If you are doing the first install of LON-CAPA at
                    219:       your site, or if you are playing with it for your own edification you
                    220:       should make your machine a 'library' server.</dd>
                    221:   <dt>LON-CAPA domain</dt>
                    222:   <dd>Each site or school which installs LON-CAPA needs its own domain.
                    223:       Here at MSU we use 'msu'.  You should choose something short but
                    224:       meaningful.  <i>Restriction: One word, no hyphens, underscores, or
1.4       bisitz    225:       special characters.</i><br>Domain names which include a departmental
1.1       raeburn   226:       abbreviation are not recommended as although LON-CAPA may start in
                    227:       a single department, other departments frequently join subsequently.
                    228:       For a domain name: 'msu' is a superior choice to 'msuphys' for example.
                    229:   </dd>
                    230:   <dt>LON-CAPA host id</dt>
                    231:   <dd>Each LON-CAPA server requires a unique internal name.  We use names
                    232:       such as "msul1" for the first library server. <i>Restriction: One word,
                    233:       no hyphens, underscores, or special characters.</i>
                    234:   </dd>
                    235:   <dt>Domain's Primary Library Server ID</dt>
                    236:    <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>
                    237:   <dt>Host administrator email</dt>
                    238:   <dd>The amount of email sent to this address is relatively minimal.  Messages
                    239:       are sent every time the system starts up, or if the system is in
                    240:       serious trouble. On a laptop, make this <tt>root@localhost</tt>.
                    241:   </dd>
                    242:   <dt>Support email address</dt>
                    243:   <dd>If you enter an e-mail address here, then users of the system
                    244:       will be able to click an "Ask Helpdesk" link in the system to
                    245:       display a web form which they will complete to request support from
                    246:       your institution's helpdesk. On form submission the contents
                    247:       will be sent to the e-mail address you specify.
                    248:   </dd>
                    249: </dl>
                    250: 
                    251: <h3>Configuring LON-CAPA</h3>
                    252: <p>
                    253: To configure and install LON-CAPA, execute the following commands:
                    254: </p>
                    255: <pre>
1.3       raeburn   256: cd /root/loncapa-X.Y.Z     (X.Y.Z should correspond to a version number like '2.10.0')
1.1       raeburn   257: ./UPDATE
                    258: </pre>
                    259: <p>
                    260: You will need to enter the LON-CAPA configuration information you determined
                    261: in the previous section.
                    262: </p>
                    263: 
                    264: <h2>6. <a name="cdc">Creating a Domain Coordinator</a></h2>
                    265: <p>
                    266: You will need at least one user at your site who has the role of
                    267: 'domain coordinator'.  This user creates accounts for other users and
                    268: grants them additional privileges.  The make_domain_coordinator.pl script
1.3       raeburn   269: invoked below requires that you enter the user's password. 
                    270: Feel free to use the "passwd username" command to change it later. 
                    271: Replace USERNAME and DOMAIN with an appropriate user name and your domain.
1.1       raeburn   272: </p>
                    273: <pre>
1.3       raeburn   274: cd /root/loncapa-X.Y.Z/loncom/build
1.1       raeburn   275: perl make_domain_coordinator.pl USERNAME DOMAIN
                    276: </pre>
                    277: 
                    278: <h2>7. <a name="sts">Start/Restart Services</a></h2>
                    279: <p>
                    280: The LON-CAPA network services take a moment to start.  Most misconfigurations
                    281: will be apparent at this step.
                    282: </p>
                    283: <pre>
                    284: /etc/init.d/loncontrol start
                    285: /etc/init.d/httpd start
                    286: </pre>
                    287: <p>
                    288: If you receive warnings when starting the httpd about missing perl modules,
                    289: please make sure you followed the instructions in
                    290: <b>Installing LON-CAPA Dependencies</b>.  If you still have errors, please
                    291: contact the MSU LON-CAPA group.
                    292: </p>
1.4       bisitz    293: 
1.1       raeburn   294: <h2>8. <a name="log">Log in to your LON-CAPA Machine</a></h2>
                    295: <p>
                    296: Point a web browser at your new machine and log in as the domain
                    297: coordinator.  Congratulations!
                    298: </p>
                    299: 
1.4       bisitz    300: <hr>
1.1       raeburn   301: <h2>If things aren't working right</h2>
                    302: <p>
                    303: If you've followed the steps above and the server doesn't start or you think
                    304: 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
                    305: automatic setup, please send us as much information as possible.
                    306: If some part of this document is unclear please let us know.
                    307: </p>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>