Annotation of doc/build/ubuntu20LTS_install.frag, revision 1.3
1.1 raeburn 1: <h1>Installing LON-CAPA on a basic Ubuntu 20.04 LTS Server</h1>
2: <p>
3: This document guides you through the process of setting up a new LON-CAPA
4: server/VM running Ubuntu 20.04 LTS Server with only the base set of packages installed.
5: The machine (virtual or real) will be configured solely as a LON-CAPA server and will be
6: expected to have no other services running. Your server/VM 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 Ubuntu 20.04 LTS .iso</a></li>
27: <li><a href="#net">Determine Network Settings</a></li>
28: <li><a href="#lin">Install Ubuntu 20.04 LTS</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 Ubuntu 20.04 LTS .iso file</a></h2>
38: <p>
39: An Ubuntu 20.04 LTS (server install) 64 bit iso can be obtained from the <a href="http://www.ubuntu.com/download/server/download">Ubuntu Server download</a> page. The .iso file can be burned to a DVD.
40: </p>
41:
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.
47:
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>
55:
56: <h2>3. <a name="lin">Ubuntu 20.04 LTS installation</a></h2>
57: <p>
1.2 raeburn 58: Installing Ubuntu Linux is straightforward.
1.1 raeburn 59: Documentation is available from
60: <a href="https://help.ubuntu.com/community/Installation">https://help.ubuntu.com/community/Installation/</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 Ubuntu Server".</dd>
69: <dt>Partitioning your Drive</dt>
70: <dd>For a fresh install you may want to use the automatic partitioning feature of the installer.
71: If you decide to customize partitioning, the following may be useful to know.
72: LON-CAPA resource files are stored in the /home directory, so the
73: majority of the disk space should be allocated here. If you have 20 GB
74: of space for Ubuntu, /home should receive at least 10 to 12 GB.
75: Since MySQL uses the /var filesystem to store its databases you should
76: have at least 4 gigs of space available on /var. Be sure to
77: include adequate swap space. A minimum is 512 Megs, but you should
78: typically have 1 or 2x as much swap space as you do physical RAM.</dd>
79:
80: <dt>Network Configuration</dt>
81: <dd>LON-CAPA will <b>not</b> work with a machine set up to use a dynamic
82: IP address. When configuring your network card, be sure to unselect
83: the DHCP option and enter in your network information.</dd>
84: <dt>Software Selection</dt>
85: <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 OpenSSH Server, if you plan to ssh into your Ubuntu 20 Server/VM from another machine.</dd>
86: </dl>
87: <p>
88: Finish installing your server, reboot it, and log in with the username you created during installation.
89: </p>
90: <h3>Firewall Configuration</h3>
91: <p>
92: Use ufw to allow incoming traffic for the following services:
93: ssh, www, https
94: </p>
95: <pre>
96: sudo ufw default deny
97: sudo ufw enable
98: sudo ufw allow ssh
99: sudo ufw allow www
100: sudo ufw allow https
101: </pre>
102: <h3>E-mail: Postfix Installation</h3>
103: <p>
104: Configure to "Internet Site" to allow LON-CAPA to send e-mail to users.
105: </p>
106: <pre>
107: sudo apt-get install postfix
108: </pre>
109: <h3>E-mail: Postfix Configuration</h3>
110: <p>
111: If you need to change the postfix configuration in the future use:
112: </p>
113: <pre>
114: sudo dpkg-reconfigure postfix
115: </pre>
116:
117: <h2>4. <a name="upd">Update your system</a></h2>
118: <p>
119: Update your system to the latest versions of the system software using apt-get
120: </p>
121: <pre>
122: sudo apt-get update
123: sudo apt-get upgrade
124: </pre>
125: <p>
126: If kernel packages were updated, reboot your system before continuing with the installation.
127: </p>
128: <h2>5. <a name="ilc">Installing LON-CAPA</a></h2>
129: <h3>Import the LON-CAPA encryption key</h3>
130: <pre>
131: wget http://install.loncapa.org/versions/ubuntu/APT-GPG-KEY-loncapa.asc
132: sudo apt-get install add-apt-key gpg
133: sudo apt-key add APT-GPG-KEY-loncapa.asc
1.2 raeburn 134: </pre>
135: <h3>Add LON-CAPA ubuntu repository to /etc/apt/sources.list file</h3>
136: <p> Execute: </p>
137: <pre>
138: sudo apt-get install software-properties-common
139: sudo apt-add-repository 'deb http://install.loncapa.org/ubuntu focal main'
140: </pre>
141: <p>
142: You can display which repositories are currently enabled by using:
143: </p>
144: <pre>
145: sudo apt-cache policy
1.1 raeburn 146: </pre>
147: <h3>Install prerequisites</h3>
148: <p> Execute: </p>
149: <pre>
150: sudo apt-get install loncapa-prerequisites
151: </pre><p>
152: This may take some minutes due to LON-CAPA's large number of dependencies.
153: </p>
154: <h3>Set MPM mode for Apache web server and enable use of cgi scripts and webDAV</h3>
155: <p>Execute: </p>
156: <pre>
157: sudo a2dismod mpm_event
158: sudo a2enmod mpm_prefork
159: sudo a2enmod cgi
160: sudo a2enmod dav
161: sudo a2enmod dav_fs
162: </pre>
163: <h3>Retrieve and execute LON-CAPA setup program</h3>
164: <p>
165: Retrieve the LON-CAPA setup script and dependencies with the following command:
166: </p>
167: <pre>
168: wget http://install.loncapa.org/linux/install.tar
169: </pre>
170: <p>
171: Extract the archive with the following command:
172: </p>
173: <pre>
174: tar xf install.tar
175: </pre>
176: <p>
177: This creates a directory named <tt>installation</tt>. Change to it and
178: execute the setup script with the following commands:
179: </p>
180: <pre>
181: cd installation
182: sudo ./install.pl
183:
184: </pre>
185: <p>
186: The script is used to prepare a Linux system to run LON-CAPA, and can also be
187: 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.
188: </p>
189: <p>
190: 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.
191: Once a choice has been entered for all nine possible actions, required changes will be made.
192: </p>
193: <p>The possible actions are:
194: <ul>
195: <li>Create the www user/group</li>
196: <li>Install the package LON-CAPA uses to authenticate users.</li>
197: <li>Set-up the MySQL database</li>
198: <li>Set-up MySQL permissions</li>
199: <li>Configure Apache web server</li>
200: <li>Configure start-up of services</li>
201: <li>Check firewall settings</li>
202: <li>Stop services not used by LON-CAPA,<br>
203: e.g., services for a print server: cups daemon</li>
204: <li>Download LON-CAPA source code in readiness for installation</li>
205: </ul>
206: </p>
207:
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
225: special characters.</i><br>Domain names which include a departmental
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>
256: cd loncapa-X.Y.Z (X.Y.Z should correspond to a version number like '2.11.3')
257: sudo ./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
269: invoked below requires that you enter the user's password.
270: Replace USERNAME and DOMAIN with an appropriate username and your domain.
271: </p>
272: <pre>
273: cd loncom/build
274: sudo perl make_domain_coordinator.pl USERNAME DOMAIN
275: cd
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. Lastly, exit from root status to resume use of your regular account.
282: </p>
283: <pre>
1.3 ! raeburn 284: sudo /home/httpd/perl/loncontrol start
1.1 raeburn 285: sudo systemctl start apache2
286: exit
287: </pre>
288: <p>
289: If you receive warnings about missing perl modules when starting Apache,
290: please make sure you followed the instructions in
291: <b>Installing prerequisites</b>. If you still have errors, please
292: contact the MSU LON-CAPA group.
293: </p>
294:
295: <h2>8. <a name="log">Log in to your LON-CAPA Machine</a></h2>
296: <p>
297: Point a web browser at your new machine and log in as the domain
298: coordinator. Congratulations!
299: </p>
300:
301: <hr>
302: <h2>If things aren't working right</h2>
303: <p>
304: If you've followed the steps above and the server doesn't start or you think
305: 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 .deb packages or errors during the
306: automatic setup, please send us as much information as possible.
307: If some part of this document is unclear please let us know.
308: </p>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to ubuntu20LTS_install.frag CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / doc / build