Annotation of doc/build/scientific6_install.frag, revision 1.9

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

FreeBSD-CVSweb <>