Annotation of doc/build/F9_install.frag, revision 1.1
1.1 ! raeburn 1: <h1>Installing LON-CAPA on a minimal Fedora 9 Linux System</h1>
! 2: <p>
! 3: This document guides you through the process of setting up a new LON-CAPA
! 4: server running Fedora 9 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>
! 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>
! 26: <li> Obtain Fedora 9 installation DVD or a Live Image CD or Rescue CD</li>
! 27: <li> Determine Network Settings</li>
! 28: <li> Install Fedora 8</li>
! 29: <li> Update your system </li>
! 30: <li> Install LON-CAPA </li>
! 31: <li> Create a Domain Coordinator </li>
! 32: <li> Start/Restart services </li>
! 33: <li> Log in to LON-CAPA </li>
! 34: </ol>
! 36: <h2>Obtain Fedora 9</h2>
! 37: <p>
! 38: Fedora 9 ISO files can be obtained from the project's main site,
! 39: <a href="http://fedoraproject.org/">http://fedoraproject.org/</a>.
! 40: You can either download an iso image(s) of the full distribution for burning to DVD,
! 41: or to CDs, or you can download a single net install for burning to CD. If you use the
! 42: net install CD, after booting from the CD, and selecting "Installation,"
! 43: you will need to select HTTP as the installation source, and specify the
! 44: host and path to Fedora 9 files for your particular architecture, e.g.,<br />
! 45: Host: http://mirrors.kernel.org/<br />
! 46: Path: fedora/releases/9/Fedora/i386/os/
! 47: </p>
! 49: <h2>Determine Network Settings</h2>
! 50: <p>
! 51: You will need to know the following network settings for your installation.
! 52: <b>Note:</b>You must have a static IP address to use LON-CAPA.
! 53: DHCP is <em>not</em> supported.
! 55: <ul>
! 56: <li>ip address </li>
! 57: <li>netmask </li>
! 58: <li>hostname </li>
! 59: <li>gateway </li>
! 60: <li>domain name server(s) </li>
! 61: </ul>
! 63: <h2>Minimal Fedora 9 Install</h2>
! 64: <p>
! 65: Installing Fedora is quite easy if you've installed any of the Red Hat products
! 66: before. Some documentation is available from
! 67: <a href="http://fedoraproject.org/wiki/Distribution/Download#Understand">
! 68: http://fedoraproject.org/wiki/Distribution/Download#Understand</a>.
! 69: Most of the installation screens are self explanatory.
! 70: There are a few steps that require comment and are dealt with below.
! 71: </p>
! 72: <dl style="list-style:square outside none">
! 73: <dt>Installation Language</dt>
! 74: <dd>Use English as your installation language.</dd>
! 75: <dt>Installation Type</dt>
! 76: <dd>If this is a fresh install choose "Install Fedora". If updating from a previous LON-CAPA installation on an earlier Fedora version (e.g., FC5 or FC6) 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 Fedora distribution in use on an existing LON-CAPA server.</dd>
! 77: <dt>Partitioning your Drive</dt>
! 78: <dd>For a fresh install may want to use the automatic partitioning feature of the installer,
! 79: however you should review the results and be prepared to modify them. If you want to customize partitioning use "Create Custom Layout".
! 80: LON-CAPA resource files are stored in the /home directory, so the
! 81: majority of the disk space should be allocated here. If you have 20 GB
! 82: of space for Fedora 8, /home should receive at least 10 to 12 gigs.
! 83: Since MySQL uses the /var filesystem to store its databases you should
! 84: have at least 4 gigs of space available on /var. Be sure to
! 85: include adequate swap space. A minimum is 512 Megs, but you should
! 86: typically have 1 or 2x as much swap space as you do physical RAM.</dd>
! 87: <dt>Network Configuration</dt>
! 88: <dd>LON-CAPA will <b>not</b> work with a machine set up to use a dynamic
! 89: IP address. When configuring your network card, be sure to unselect
! 90: the DHCP option and enter in your network information.</dd>
! 91: <dt>Software</dt>
! 92: <dd>Uncheck the "Office and Productivity" software option. Click the "Customize Now" radio button and for a minimal install uncheck all packages except "Base" in the Base System category.</dd>
! 93: </dl>
! 94: <p>
! 95: Finish installing your server, reboot it, and log in as root. The first time you log-in, the Setup Agent will be displayed. If you have not already done so you can use this to configure your network interface.
! 96: <p>Exit the Setup Agent</p>
! 97: <h2>Configure SELinux</h2>
! 98: <p>
! 99: The default Fedora 9 installation includes SELinux enabled. Until such time as an SELinux security policy has been created for LON-CAPA, SELinux should be disabled.
! 100: Retrieve the loncapa_selinux_config file from the LON-CAPA install site:
! 101: </p>
! 102: <pre>
! 103: wget http://install.loncapa.org/versions/fedora/9/loncapa_selinux_config
! 104: </pre>
! 105: <p>
! 106: Install the selinux config file
! 107: </p>
! 108: <p>
! 109: <pre>
! 110: mv /etc/selinux/config /etc/selinux/config.backup
! 111: mv loncapa_selinux_config /etc/selinux/config
! 112: </pre>
! 113: </p>
! 114: <h2>Firewall Configuration</h2>
! 115: To configure the firewall settings, use the system-config-firewall utility. Execute: <p>
! 116: <pre>lokkit</pre></p><p>
! 117: <dt>Firewall Configuration</dt>
! 118: <dd>Select Security Level: Enabled, and allow incoming: SSH (remote login), WWW (HTTP) and secure WWW (HTTPS). You should also open two additional ports used by LON-CAPA for TCP traffic: 5663 and 8080.</dd>
! 119: <br />Exit the system-config-firewall</p>
! 120: <h2>Update your system</h2>
! 121: <p>
! 122: Update your system to the latest versions of the system software using yum.
! 123: Yum is configured to check encyption keys for the packages it installs, so
! 124: you need to import the keys before invoking yum.
! 125: </p>
! 126: <pre>
! 127: rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora
! 128: rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-8-and-9
! 130: yum update
! 131: </pre>
! 132: <p>
! 133: <b>Reboot</b> your system before continuing with the installation.
! 134: </p>
! 135: <p>
! 136: Retrieve the F9_loncapa_yum file from the LON-CAPA install site:
! 137: </p>
! 138: <pre>
! 139: wget http://install.loncapa.org/versions/fedora/9/F9_loncapa_yum.conf
! 140: </pre>
! 141: <p>
! 142: Install the F9_loncapa_yum.conf
! 143: </p>
! 144: <p>
! 145: <pre>
! 146: mv /etc/yum.conf /etc/yum.conf.backup
! 147: cp F9_loncapa_yum.conf /etc/yum.conf
! 148: </pre>
! 149: </p>
! 150: <h2>Installing LON-CAPA</h2>
! 151: <h3>Install prerequisites</h3>
! 152: <p>Import the LON-CAPA encryption key</p>
! 153: <pre>
! 154: rpm --import http://install.loncapa.org/versions/fedora/RPM-GPG-KEY-loncapa
! 155: </pre>
! 156: <p> Execute: </p>
! 157: <pre>
! 158: yum install LONCAPA-prerequisites
! 159: </pre><p>
! 160: This may take a moment due to LON-CAPA's large number of dependencies.
! 161: </p>
! 162: <h3>Retrieve and execute LON-CAPA setup program</h3>
! 163: <p>
! 164: Retrieve the LON-CAPA setup with the following command:
! 165: </p>
! 166: <pre>
! 167: wget http://install.loncapa.org/versions/fedora/9/F9_install.tar
! 168: </pre>
! 169: <p>
! 170: Extract the archive with the following command:
! 171: </p>
! 172: <pre>
! 173: tar xf F9_install.tar
! 174: </pre>
! 175: <p>
! 176: This creates a directory named <tt>installation</tt>. Change to it and
! 177: execute the setup script with the following commands:
! 178: </p>
! 179: <pre>
! 180: cd installation
! 181: ./install.pl
! 182: </pre>
! 183: <p>
! 184: This script will prompt you for the MySQL root password and will download the latest LON-CAPA release.<br />
! 185: You can safely ignore the following warnings from gcc 4 when compiling pwauth:<br />
! 186: <tt>
! 187: pwauth.c: In function ‘lastlog’:
! 188: <ul>
! 189: <li>pwauth.c:541: warning: incompatible implicit declaration of built-in function ‘strncpy’</li>
! 190: <li>pwauth.c:543: warning: incompatible implicit declaration of built-in function ‘strlen’</li>
! 191: </ul>
! 192: pwauth.c: In function ‘main’:
! 193: <ul>
! 194: <li>pwauth.c:692: warning: incompatible implicit declaration of built-in function ‘strlen’</li>
! 195: </ul>
! 196: </tt>
! 198: </p>
! 200: <h3>Determine LON-CAPA Settings</h3>
! 201: <p>
! 202: LON-CAPA requires a number of identifying parameters to be set in order
! 203: for it to function at all. Below is a list with descriptions.
! 204: </p>
! 205: <dl>
! 206: <dt>Host Type (library or access)</dt>
! 207: <dd>The server must be designated a 'library' or an 'access' server. In
! 208: general you should have a library server for your instructors to create
! 209: their course content on and run their courses. Students should connect
! 210: to access servers. If you are doing the first install of LON-CAPA at
! 211: your site, or if you are playing with it for your own edification you
! 212: should make your machine a 'library' server.</dd>
! 213: <dt>LON-CAPA domain</dt>
! 214: <dd>Each site or school which installs LON-CAPA needs its own domain.
! 215: Here at MSU we use 'msu'. You should choose something short but
! 216: meaningful. <i>Restriction: no spaces, underscores or
! 217: special characters (besides - and .).</i><br />
! 218: Domain names which include a departmental
! 219: abbreviation are not recommended as although LON-CAPA may start in
! 220: a single department, other departments frequently join subsequently.
! 221: For a domain name: 'msu' is a superior choice to 'msuphys' for example.
! 222: </dd>
! 223: <dt>LON-CAPA host id</dt>
! 224: <dd>Each LON-CAPA server requires a unique internal name. We use names
! 225: such as "msul1" for the first library server. <i>Restriction: One word,
! 226: no hyphens, underscores, or special characters.</i>
! 227: </dd>
! 228: <dt>Domain's Primary Library Server ID</dt>
! 229: <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>
! 230: <dt>Host administrator email</dt>
! 231: <dd>The amount of email sent to this address is relatively minimal. Messages
! 232: are sent every time the system starts up, or if the system is in
! 233: serious trouble. On a laptop, make this <tt>root@localhost</tt>.
! 234: </dd>
! 235: <dt>Support email address</dt>
! 236: <dd>If you enter an e-mail address here, then users of the system
! 237: will be able to click an "Ask Helpdesk" link in the system to
! 238: display a web form which they will complete to request support from
! 239: your institution's helpdesk. On form submission the contents
! 240: will be sent to the e-mail address you specify.
! 241: </dd>
! 242: </dl>
! 244: <h3>Configuring LON-CAPA</h3>
! 245: <p>
! 246: To configure and install LON-CAPA, execute the following commands:
! 247: </p>
! 248: <pre>
! 249: cd /root/loncapa-X.Y.Z (X.Y.Z should correspond to a version number like '2.7.1')
! 250: ./UPDATE
! 251: </pre>
! 252: <p>
! 253: You will need to enter the LON-CAPA configuration information you determined
! 254: in the previous section.
! 255: </p>
! 257: <h2>Creating a Domain Coordinator</h2>
! 258: <p>
! 259: You will need at least one user at your site who has the role of
! 260: 'domain coordinator'. This user creates accounts for other users and
! 261: grants them additional privileges. The make_domain_coordinator.pl script
! 262: invoked below requires that you enter the users password. The password will
! 263: show in plaintext as you type it. Feel free to use the "passwd username"
! 264: command to change it later. Replace USERNAME and DOMAIN with an
! 265: appropriate user name and your domain.
! 266: </p>
! 267: <pre>
! 268: cd /root/loncapa-N.N/loncom/build
! 269: perl make_domain_coordinator.pl USERNAME DOMAIN
! 270: (WILL PROMPT FOR PASSWORD HERE)
! 271: </pre>
! 273: <h2>Start/Restart Services</h2>
! 274: <p>
! 275: The LON-CAPA network services take a moment to start. Most misconfigurations
! 276: will be apparent at this step.
! 277: </p>
! 278: <pre>
! 279: /etc/init.d/loncontrol start
! 280: /etc/init.d/httpd start
! 281: </pre>
! 282: <p>
! 283: If you receive warnings when starting the httpd about missing perl modules,
! 284: please make sure you followed the instructions in
! 285: <b>Installing LON-CAPA Dependencies</b>. If you still have errors, please
! 286: contact the MSU LON-CAPA support team.
! 287: </p>
! 288: <h2>Log in to your LON-CAPA Machine</h2>
! 289: <p>
! 290: Point a web browser at your new machine and log in as the domain
! 291: coordinator. Congratulations!
! 292: </p>
! 294: <h2>If things aren't working right</h2>
! 295: <p>
! 296: If you've followed the steps above and the server doesn't start or you think
! 297: there's something wrong, please send a <a href="http://support.loncapa.org/help">help request</a> to the MSU LON-CAPA support team. If there were errors in installation of the dependency RPMs or errors during the
! 298: automatic setup, please send us as much information as possible.
! 299: If some part of this document is unclear please let us know.
! 300: </p>