Annotation of doc/build/scientific7_install.frag, revision 1.4

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

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