Return to debian11_install.frag CVS log

Up to [LON-CAPA] / doc / build

- An additional action is available when running set up script (install.pl).
- Replace non-functional help link with suggestion to email helpdesk.

<h1>Installing LON-CAPA on a basic Debian 11 Server</h1>
<p>
This document guides you through the process of setting up a new LON-CAPA
server/VM running Debian 11 with only the base set of packages installed. 
The machine (virtual or real) will be configured solely as a LON-CAPA server and will be 
expected to have no other services running.  Your server/VM is expected to have
a reasonably fast connection to the internet.
</p><p>
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 Linux 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><a href="#obt">Obtain Debian 11 .iso</a></li>
  <li><a href="#net">Determine Network Settings</a></li>
  <li><a href="#lin">Install Debian 11</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>

<hr>
<h2>1. <a name="obt">Obtain Debian 11 .iso file</a></h2>
<p>
Debian 11 .iso files can be obtained from the <a href="https://www.debian.org/distrib/">Getting Debian</a> page. Either a small installation image .iso for installation over the network or a larger complete installation image .iso can be downloaded.
</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.
DHCP is <em>not</em> supported.

<ul>
  <li>ip address </li>
  <li>netmask </li>
  <li>hostname </li>
  <li>gateway </li>
  <li>domain name server(s) </li>
</ul>

<h2>3. <a name="lin">Debian 11 installation</a></h2>
<p>
Installing Debian Linux is straightforward.
Documentation is available from
<a href="https://www.debian.org/releases/stable/installmanual">https://www.debian.org/releases/stable/installmanual/</a>
Most of the installation screens are self explanatory. (Choose "Graphical Install").
There are a few steps that require comment and are dealt with below.
</p>
<dl style="list-style:square outside none">
   <dt>Installation Language</dt>
   <dd>Use English as your installation language.</dd>
   <dt>Partitioning your Drive</dt>
   <dd>For a fresh install you may want to use the automatic partitioning feature of the installer.
       If you decide to customize partitioning, the following may be useful to know.
       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 Debian, /home should receive at least 10 to 12 GB. 
       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 
       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 
       IP address.  When configuring your network card, be sure to unselect
       the DHCP option and enter in your network information.</dd>
   <dt>Software Selection</dt>
   <dd>The base system will be installed. Once that is complete you will have the option to select additional software collections. By default, "standard system utilities" will be checked -- leave that checked, and (optionally) also check SSH Server, if you plan to ssh into your Debian 11 Server/VM from another machine.</dd>
</dl>
<p>
Finish installing your server, reboot it, and log in with the username you created during installation.
</p>
<h3>Enabling sudo</h3>
<p>If you wish to allow the username created during installation to have administration privileges using sudo, use su to become root and execute the following, replacing <i>&lt;username&gt;</i> with that specific username:
</p>
<pre>
apt-get install sudo
/sbin/adduser &lt;username&gt; sudo
exit
</pre>
<p>Now logout and log in again with that username. If you prefer not to use sudo, then you should omit all instances of <i>sudo</i> when executing all commands listed on the remainder of this page, after using su to become root.
</p>
<h3>Firewall Configuration</h3>
<p>
Use ufw to allow incoming traffic for the following services:
ssh, www, https
</p>
<p>Check if ufw is installed</p>
<pre>sudo dpkg-query -s ufw |grep Status</pre>
<p>If the result is not: <i>Status: install ok installed</i>, then install it:
<pre>sudo apt-get install ufw</pre>
<p>Configure ufw by executing the following:</p>
<pre>
sudo ufw default deny
sudo ufw enable
sudo ufw allow ssh
sudo ufw allow www
sudo ufw allow https
sudo ufw reload
</pre>
<h3>E-mail: Postfix Installation</h3>
<p>
Configure to "Internet Site" to allow LON-CAPA to send e-mail to users.
</p>
<pre>
sudo apt-get install postfix
</pre>
<h3>E-mail: Postfix Configuration</h3>
<p>
If you need to change the postfix configuration in the future use:
</p>
<pre>
sudo dpkg-reconfigure postfix
</pre>
<h3>Time synchronization service</h3>
<p>
You will use chrony for time synchronization, so if timesyncd is installed you should remove it.
</p>
<pre>
sudo systemctl stop systemd-timesyncd
sudo systemctl disable systemd-timesyncd
sudo apt-get remove systemd-timesyncd
sudo apt-get install chrony
sudo systemctl start chrony
sudo systemctl enable chrony
</pre>
<h2>4. <a name="upd">Update your system</a></h2>
<p>
Update your system to the latest versions of the system software using apt-get
</p>
<pre>
sudo apt-get update
sudo apt-get upgrade
</pre>
<p>
If kernel packages were updated, reboot your system before continuing with the installation.
</p>
<h2>5. <a name="ilc">Installing LON-CAPA</a></h2>
<h3>Import the LON-CAPA encryption key</h3>
<p>Check if gpg is installed</p>
<pre>sudo dpkg-query -s gpg |grep Status</pre>
<p>If the result is not: <i>Status: install ok installed</i>, then install it:</p>
<pre>sudo apt-get install gpg</pre>
<p>Check if wget is installed</p>
<pre>sudo dpkg-query -s wget |grep Status</pre>
<p>If the result is not: <i>Status: install ok installed</i>, then install it:</p>
<pre>sudo apt-get install wget</pre>
<p>Check if /etc/apt/keyrings directory exists by executing:</p>
<pre>
ls -al /etc/apt/keyrings
</pre>
<p>If it is missing, create it by executing:</p>
<pre>
sudo mkdir /etc/apt/keyrings
</pre>
<p> Execute: </p>
<pre>
wget -q -O - https://install.loncapa.org/versions/debian/APT-GPG-KEY-loncapa.asc | gpg --dearmor | sudo tee /etc/apt/keyrings/loncapa.gpg > /dev/null
</pre>
<h3>Add LON-CAPA debian repository to /etc/apt/sources.list.d</h3>
<p> Execute: </p>
<pre>
echo "deb [signed-by=/etc/apt/keyrings/loncapa.gpg] https://install.loncapa.org/debian bullseye main" | sudo tee /etc/apt/sources.list.d/loncapa.list
</pre>
<p>
You can display which standard Debian repositories are currently enabled by executing:
</p>
<pre>
grep '^deb ' /etc/apt/sources.list |grep ' bullseye'
</pre>
<p>The output should be similar to the following (with deb.debian.org replaced with your preferred mirror site):</p>
<pre>
deb http://deb.debian.org bullseye main
deb http://security.debian.org/debian-security bullseye-security main
deb http://deb.debian.org bullseye-updates main
</pre>
<h3>Install prerequisites</h3>
<p> Execute: </p>
<pre>
sudo apt-get update
sudo apt-get install loncapa-prerequisites
</pre><p>
This may take some minutes due to LON-CAPA's large number of dependencies.
</p>
<h3>Set MPM mode for Apache web server and enable use of cgi scripts and webDAV</h3>
<p>Execute: </p>
<pre>
sudo a2dismod mpm_event
sudo a2enmod mpm_prefork
sudo a2enmod cgi
sudo a2enmod dav
sudo a2enmod dav_fs
</pre>
<h3>Retrieve and execute LON-CAPA setup program</h3>
<p>
Retrieve the LON-CAPA setup script and dependencies with the following command:
</p>
<pre>
wget http://install.loncapa.org/linux/install.tar
</pre>
<p>
Extract the archive with the following command:
</p>
<pre>
tar xf install.tar
</pre>
<p>
This creates a directory named <tt>installation</tt>.  Change to it and
execute the setup script with the following commands:
</p>
<pre>
cd installation
sudo ./install.pl
</pre>
<p>
The script is used to prepare a Linux system to run LON-CAPA, and can also be
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.
</p>
<p>
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.
Once a choice has been entered for all ten possible actions, required changes will be made.
</p>
<p>The possible actions are:
<ul>
<li>Create the www user/group</li>
<li>Install the package LON-CAPA uses to authenticate users.</li>
<li>Set-up the MySQL database</li>
<li>Set-up MySQL permissions</li>
<li>Configure Apache web server</li>
<li>Configure systemd security settings for Apache web server</li>
<li>Configure start-up of services</li>
<li>Check firewall settings</li>
<li>Stop services not used by LON-CAPA,<br>
    e.g., services for a print server: cups daemon</li>
<li>Download LON-CAPA source code in readiness for installation</li>
</ul>
</p>

<h3>Determine LON-CAPA Settings</h3>
<p>
LON-CAPA requires a number of identifying parameters to be set in order
for it to function at all.  Below is a list with descriptions.
</p>
<dl>
  <dt>Host Type (library or access)</dt>
  <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 
      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 
      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, 
      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 
      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 
      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.
  </dd>
</dl>

<h3>Configuring LON-CAPA</h3>
<p>
To configure and install LON-CAPA, execute the following commands:
</p>
<pre>
cd ../loncapa-X.Y.Z  (X.Y.Z should correspond to a version number like '2.11.5')
sudo ./UPDATE
</pre>
<p>
You will need to enter the LON-CAPA configuration information you determined 
in the previous section.
</p>

<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 user's password.
Replace USERNAME and DOMAIN with an appropriate username and your domain.
</p>
<pre>
cd loncom/build
sudo perl make_domain_coordinator.pl USERNAME DOMAIN
cd
</pre>

<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.
</p>
<pre>
sudo /home/httpd/perl/loncontrol start
sudo systemctl restart apache2
exit
</pre>
<p>
If you receive warnings about missing perl modules when starting Apache,
please make sure you followed the instructions in 
<b>Installing prerequisites</b>.  If you still have errors, please
contact the MSU LON-CAPA group.
</p>

<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 
there's something wrong, please contact the LON-CAPA helpdesk.
Installation/update support is available from: helpdesk at loncapa.org
(replace " at " with @).
If there were errors in installation of the dependency .deb packages 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.
</p>