LAMS installation and configuration: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
(Added references to LAMS version 4.5, included default users, improve git instructions)
 
(120 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{incomplete}}
{{incomplete}}
 
<!-- <pageby nominor="false" comments="false"/> -->
== Definition ==
== Definition ==


This page contains installation tips for [[LAMS]]. Mostly LAMS 2.1RC1 for Solaris 10.
This page contains installation tips for a '''fresh''' install of [[LAMS]].


LAMS is a JAVA/JBOSS-based application and needs some installation skills on Windows and good installation skills for Unix.
LAMS is a JAVA/JBOSS-based application and needs some installation skills on Windows and good installation skills for Unix.


'''READ THIS''' - [[User:Daniel K. Schneider|Daniel K. Schneider]] 16:31, 18 September 2008 (UTC)
Note: I put the legacy stuff in the [[Talk:LAMS_installation_and_configuration|discussion page]], e.g. LAMS 2.x for Ubuntu, LAMS 2.1RC for Solaris
* I soon will install a new version
 
* I put the legacy stuff in the [[Talk:LAMS_installation_and_configuration|discussion page]], e.g. LAMS 2.1RC for Solaris
== LAMS 4.5+ ==
As of July 2021, LAMS 4.5 was released and is the latest stable release.
 
=== Getting the LAMS source code ===
Source code is available from [https://github.com/lamsfoundation/lams Github]. The code branch to use is v4.5
 
'''Required software'''
* Git
* Wildfly 14.0.1
* OpenJDK 11
* MySQL 8.0
* Ant  (Java task compiler)
 
==== OpenJDK 11 ====
In Debian/Ubuntu 20.04
 
$ sudo apt install openjdk-11-jdk-headless
$ sudo apt install fontconfig
==== MySQL 8.0 DB ====
 
$ wget https://dev.mysql.com/get/mysql-apt-config_0.8.15-1_all.deb
$ sudo dpkg -i  mysql-apt-config_0.8.15-1_all.deb
$ sudo apt update
$ sudo apt install mysql-server
$ sudo mysql_secure_installation
 
===== Basic MySQL configuration =====
''/etc/mysql/mysql.conf.d/mysqld.cnf''
 
...
# LAMS stuff
explicit_defaults_for_timestamp
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci
transaction-isolation=READ-COMMITTED
sql-mode="STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"
max_allowed_packet=32M
# Record slow queries
slow_query_log = 1
slow_query_log_file = /var/log/mysql/mysql-slow.log
long_query_time = 10
[mysqldump]
default-character-set=utf8mb4
hex-blob=1
single-transaction=1
quick=1
...
 
After installing MySQL, create a user and a DB for LAMS and grant appropriate permissions:
 
DROP DATABASE IF EXISTS lams;
CREATE DATABASE lamsdb DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci;
SET FOREIGN_KEY_CHECKS=1;
GRANT ALL PRIVILEGES ON lamsdb.* TO lamsdbuser@localhost IDENTIFIED BY 'real_secret_pw';
REVOKE SUPER ON *.* from lamsdbuser@localhost;
 
==== Wildfly 14.0.1 ====
 
$ wget https://download.jboss.org/wildfly/14.0.1.Final/wildfly-14.0.1.Final.tar.gz
$ cd /opt/lams
$ tar xvzf wildfly-14.0.1.Final.tar.gz
 
==== LAMS source code pre-compilation ====
LAMS is open source and its code is available from [https://github.com/lamsfoundation/lams GitHub]<syntaxhighlight lang="bash">
git clone https://github.com/lamsfoundation/lams.git
</syntaxhighlight>By default branch is LAMS' latest stable release as of July 2021, that's version 4.5. If you need a previous branch, see [https://github.com/lamsfoundation/lams/branches other branches available].
 
Wherever you have your LAMS v4.5 code, edit the following files
 
'''common.properties'''
 
Primarily the DB settings and based system.
 
If you are building LAMS using Windows, set the osPropertiesName to "windows" instead of "unix".
 
...
#======== DATABASE PROPERTIES =========
db.host=localhost
db.port=3306
db.name=lamsdb
db.username=lamsdbuser 
db.password=real_secret_pw
...
osPropertiesName=unix
...
 
''If you are building LAMS in a unix based system, then change the file '''unix.properties.''' If you are using Windows, then change the '''windows.properties''' file instead.''
 
'''unix.properties'''
 
Here you will need to figure a path to the content repository
contentrepository.base=/var/opt/lams
 
The path to your Wildfly folder
server.home=/usr/local/wildfly-14.0.1/
 
...
contentrepository.base=/var/opt/lams
...
server.home=/opt/lams/wildfly-14.0.1/
...
 
==== Compilation and deployment ====
 
cd lams_build
ant deploy-lams
 
If no errors occurred, you are ready to start Wildfly.
 
cd /opt/lams/wildfly-14.0.1/bin
./standalone.sh
 
 
LAMS should be available at localhost:8080/lams/ 
 
By default, LAMS has a set of preconfigured users:
{| class="wikitable"
|+Default Users
!user
!password
!role
|-
|sysadmin
|sysadmin
|System administrator
|-
|test1
|test1
|Teacher, student, tutor
|-
|test2
|test2
|Teacher, student, tutor
|-
|test3
|test3
|Teacher, student, tutor
|-
|test4
|test4
|Teacher, student, tutor
|}
Of course, you can create and import users and courses into LAMS at any time from the sysadmin menu. 
 
(OPTIONAL) Wildfly comes with a ton of libraries that LAMS does not use. So to slim Wildfly to only use the libs that LAMS uses, please run the following ant task in the lams_build folder: <syntaxhighlight lang="bash">
ant slim-standalone
</syntaxhighlight>
 
== LAMS 3.1 ==
 
As of March 2019, we do have a new LAMS installation that works fine in virtual server running Ubuntu 18.x.
 
* [https://github.com/lamsfoundation/lams Github]
* [https://wiki.lamsfoundation.org/display/lams/LAMS+3.1+in+Ubuntu Quick compile guide for Ubuntu]
 
However, I do not feel doing system administration anymore (except for this wiki) and I asked our systems person to do it. So there is not documentation, sorry.
 
Lams Moodle integration. There are two types of integration.
* LAMS - Moodle integration with a Moodle plugin.
* [[IMS Learning Tools Interoperability|LTI]] integration, i.e. Moodle can "consume" LAMS contents


== LAMS 2.1.1 on Solaris ==
=== LTI external tool integration ===


Lams 2.0 was released on December 6 2006. Since then, there were very several minor upgrades.
Documentation
On March 2008, the current release is 2.1.1 (17:33, 18 September 2008 (UTC)).  
* [https://docs.moodle.org/36/en/External_tool_settings External tool settings] (Moodle 3.6 manual).  
* [https://wiki.lamsfoundation.org/display/lams/Integrations Integrations] (LAMS documentation).


These installation notes refers mostly to the 2.1.1 install, but it should help with 2.0.4 too. Official LAMS instructions are a bit Linux centric and this is main reason why you might have a look at this. My notes also
An administrator can manually configure external tools in Site administration > Plugins > Activity modules > External tool> Manage tools so that they are available across the site.  
should work with older Solaris versions (just make sure to upgrade Java if needed and in this case to set the Java path).


First, read the instructions in:
=== Moodle LAMS integration through a Moodle plugin ===
* [http://wiki.lamsfoundation.org/display/lamsdocs/Unix+Installer+Help Unix Installation and Updating Help] (if you plan to use the unix installer)
 
* [http://wiki.lamsfoundation.org/display/lams/Building+LAMS Building LAMS] (if you plan a source install)
* We did that with LAMS 2.5. To be tested with LAMS 3.0. There is a [https://wiki.lamsfoundation.org/display/lams/Integrations plugin for download] and the method should be the same.
* [http://wiki.lamsfoundation.org/display/lams/Development+Environment Development Environment]
 
== LAMS 3.0 ==
 
As of November 2018, the current system is LAMS 3.x. You can test this with a [https://demo.lamsfoundation.org/lams/ demo version]. '''Below, we started documenting an installation on Ubunt 18x, but we did not find time to complete the installation'''. As you can see something went wrong. Instead, we installed LAMS 3.1 on a virtual server machine.
 
'''History'''
 
LAMS 2.5 was initially promised for 2014. Then, after a funding cut, the LAMS team was mostly disbanded and the core team found a new "home" in Singapour. Sometimes in 2016 the version number was changed to LAMS 3.0.  
 
'''Status as of Nov 2018'''


Disclaimer: I am not a good sysadmin nor is it my idea of fun. This is not a manual, but '''just''' my private installation notes I am willing to share. - [[User:Daniel K. Schneider|Daniel K. Schneider]] 18:30, 20 March 2008 (MET)
* The old LAMS community pages are still online, but no longer maintained.


So, open a terminal under root ....
* LAMS 3.x it is available on [https://github.com/lamsfoundation/lams Github], but documentation is lacking. Also, there is no installer. You will have to install and configure like in the "good" old times ....
** LAMS 3.x will run under old 8.2.1 version of [http://wildfly.org/downloads/ Wildfly], formerly JBoss (?). E.g. see [https://www.howtoforge.com/tutorial/ubuntu-wildfly-jboss-installation/ How to install WildFly (JBoss) Java Application Server on Ubuntu 18.04].
** Create a MySQL database
** Build the system with ANT


=== Prerequisite 0: Infrastructure ===
* https://demo.lamsfoundation.org/lams/ does run a 3.x demo version for which you can require a login.


* Make sure your organization doesn't stiffle your creativity with Firewalls. If they do, expect '''a lot''' of extrawork.
* LAMS 3.x is available as commercial offering through [https://www.lamsinternational.com/ Lams International] and also through content services (to be verified).
* Also the 8080 port should be free. Some software like Skype just randomly take up ports. If you run an other server, read [http://wiki.lamsfoundation.org/display/lamsdocs/Changing+Server+Ports+for+LAMS  Changing Server Ports for LAMS]
* Hardware and OS: Any Windows, Linux, MacOS X, Solaris etc. machine will do since LAMS is programmed in JAVA. You just need some diskspace, substantial memory and a not too old JAVA. Also, you may have to adapt some scripts to your special unix brand.


=== Prerequisite 1: Java software ===


; Java + ant


Solaris 10 ought to have the right Java + Ant installed. Ant is an installation program like make. Note: You need the JDK/JSE or whater Sun decided to rename it (i.e. the compiler, not just the runtime)
=== Prerequisites ===


Check if Java can be found, i.e. type:
;Java
: Usually, this is installed. Check it. In principle, the Open JDK should work, however we do not know if that is true for older version. If it does not (we have to test) this, then it should be replaced with Oracle one. '''This is very likely the case'''.
  java -version
  java -version
... you should have java 1.5.x or better. If you don't, check the system for another java or install a new one. If you do so, make sure to specify the right path according to instructions from the LAMS install page.
gives something link:
openjdk version "10.0.2" 2018-07-17
OpenJDK Runtime Environment (build 10.0.2+13-Ubuntu-1ubuntu0.18.04.1)
OpenJDK 64-Bit Server VM (build 10.0.2+13-Ubuntu-1ubuntu0.18.04.1, mixed mode)


=== Prerequisite 2: Wildfire ===
Installation did not work with java 11, so I tried '''OpenJDK version 8'''. If you don't have Java 8 (it already was on my system), install it first.


This is a [http://en.wikipedia.org/wiki/Xmpp XMPP] (Jabber) chat server, that actually is called Openfire now. See:
  udo apt install openjdk-8-jdk
* [http://wiki.lamsfoundation.org/display/lamsdocs/Installing+Wildfire+for+LAM Installing Wildfire for LAMS]
* Also read [http://www.igniterealtime.org/builds/wildfire/docs/latest/documentation/install-guide.html Installation guide] (at Igniterealtime).


You don't really need open/wildfire (but then either your students can't chat). You also may try to use an existing server that works with LAMS. I guess that there ought to be free servers you can use.
To use Java 8 by default, you can do the following. Most software seems to use Java 8 anyhow ....
* LAMS folks say to install an '''old''' 2.6.2. version. Links are available from the LAMS page, you won't find it at [http://www.igniterealtime.org/ Ignite realtime]. Note: I have to see whether this is still true, but for the moment I just complied.
sudo update-alternatives --config java
* Since this server is written in Java you can take the [http://www.igniterealtime.org/builds/wildfire/wildfire_2_6_2.tar.gz Mac OSX and others] version (i.e. a tar ball).


Installation steps:


1) Uncompress in /usr/local/wildfire or some other place
;SASS (some kind of CSS pre-processor)
sudo apt install sass


2) Start the server with ./bin/wildfire start
;Ant
* This is a typical startup script. You later can copy this script to /etc/init.d/ etc.
sudo apt install ant


3) Configure this server through the web interface. If you are lucky you will have a web browser on your server and an X11 connection.  
;If exists, stop your old LAMS, e.g.
http://localhost:9090/  
: /etc/init.d/lams2 stop
Else use an URL like:  http://yourhost.org:9090/ ... it should work I think. But do it as fast as possible since you have to set passwords and stuff.


* Use "embedded database" if you want to make the install shorter, else you can set it up with mysql
=== Kill old LAMS ===


The configuration process will ask you to fill in a few forms. Just make sure that you use the right server names. You then can log as administrator and you will have access to an administration console.
We did not try to upgrade an old LAMS installation since we did not have many sequences that were worthwhile keeping and since there are no instructions on how to do this. So, export sequences that are worth keeping ...


* Tick "Don't Show History" (Group Chat -> History Settings), but you can do this later
; Remove the startup script for old lams (or similar if it exists)
grep -R lams /etc
: For example
rm /etc/rc6.d/K02lams2
rm /etc/rc5.d/S02lams2
rm /etc/rc4.d/S02lams2
rm /etc/rc3.d/S02lams2
rm /etc/rc2.d/S02lams2
rm /etc/rc1.d/K02lams2
rm /etc/rc0.d/K02lams2


4) Test it. You may want to install a [http://en.wikipedia.org/wiki/List_of_Jabber_client_software jabber client], e.g. gajim (Ubuntu users can read an article on [https://wiki.ubuntu.com/Jabber Jabber]
=== Install and configure Wildfly ===
# cd /src
wget http://download.jboss.org/wildfly/8.2.1.Final/wildfly-8.2.1.Final.tar.gz
tar xvfz wildfly-8.2.1.Final.tar.gz


5) Security:
sudo mv /src/wildfly-8.2.1.Final /opt/wildfly
You may restrict login to given set of IP addresses or even disable account creation. Chat servers may be taken over by not so friendly people.
sudo chown you:you /opt/wildfly
* Edit Server Settings->Registration and Login
cd /opt/wildfly
more README.txt 


Installing wildfire should be easy, it was for me. It's a fairly popular product...
#Now test
cd /opt/wildfly/bin
./standalone.sh
# If your X server works and if you got Firefox installed on the server machine
firefox --new-instance
http://localhost:9990


''''' (the rest: soon ...) ''''
=== Create a new MySQL database and user ===


=== Prerequisite 3: Configure MySQL for LAMS ===
(1) Check what you got


=== Pre-install configuration ===
mysqlshow -p -u root


=== Using the installer ===
(2) Create a new database and user
 
mysql -u root -p
and copy/paste an adapted version of the following
<source lang="sql">
DROP DATABASE IF EXISTS lams3; 
CREATE DATABASE lams3 DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci;
SET FOREIGN_KEY_CHECKS=1;
GRANT ALL PRIVILEGES ON lams3.* TO lams@localhost IDENTIFIED BY 'real_secret_pw';
REVOKE PROCESS,SUPER ON *.* from lams@localhost;
</source>


=== Configuration ===
After aborting wildfly you can run intot the following type of error (see also [https://lamscommunity.org/dotlrn/clubs/technicalcommunity/forums/message-view?message_id=1069554 this], dated 07/14/10)
/opt/wildfly/bin$ 18:25:34,136 INFO  [JdbcMigrationLauncher]  If this isn't from a long-running patch, but a stale lock, either:
18:25:34,136 INFO  [JdbcMigrationLauncher]    1) run MigrationTableUnlock (probably 'ant patch.unlock')
18:25:34,136 INFO  [JdbcMigrationLauncher]    2) set the lockPollRetries property so the lock times out
18:25:34,136 INFO  [JdbcMigrationLauncher]        (this is dangerous in combination with long-running patches)
  18:25:34,136 INFO  [JdbcMigrationLauncher]    3) set the 'patch_in_progress' in the patches table to 'F'


=== Discussion / Problems ===
In the LAMS DataBASE, run the following SQL
update patches set patch_in_progress = "F";


=== Dowload, configure and build LAMS ===


== Moodle - LAMS integration ==
In order to find these files again, we decided to put them in /opt but any place can do.


The [http://wiki.lamsfoundation.org/display/lamsdocs/LAMS+v2.0+Integration+Setup+Step-by-Step+Guide  LAMS v2.0 Integration Setup Step-by-Step Guide] is fairly well done :)
sudo chown you:your_group /opt/lams
cd /opt/
git clone https://github.com/lamsfoundation/lams.git


=== Short installation summary (see the above guide) ===
'''Edit the configuration files'''


I managed this to work with LAMS 2.1RC1. I did fail with an early LAMS 2.0 version - [[User:Daniel K. Schneider|Daniel K. Schneider]] 18:30, 20 March 2008 (MET). The current setup is:
cd /opt/lams/lams_build
* Moodle runs on one machine (tecfax.unige.ch)
* LAMS runs on a different machine


I did not yet use LAMS in production so far. But I inserted the [http://www.lamscommunity.org/dotlrn/clubs/educationalcommunity/highered//lams-seq/sequence?seq%5fid=19738  Beyond the VLE] module through Moodle. I was able to:
* Make a copy of the *.properties files just be sure. In addition, do not change the properties files themselves since they may be overridden by upgrades. Put them into a file called build.properties.
* Use with Moodle student ID's (test and test2)
** not use with Moodle student ID's as monitor (that's correct)
* Use it with Moodle admin ID as student and monitor
* Chat did work.


; On the Moodle side
Change common.properties:
First of all '''make sure''' that you do no skip step 4 below (you need the LAMS v2 module and ''not'' LAMS !)
db.host=localhost
db.port=3306
db.name=lams3
db.username=lams.....
db.password=real_secret....


# Get a '''new''' file (it seems that fixes are made sometimes)
Change file unix.properties:
# Unzip the file
# Maybe not the best place for you, but at TECFA we always create a /data directory for data that must be kept, e.g. portalware, web server files, etc.
# Move the lamstwo directory to moodle/mod/
  contentrepository.base=/data/lams
# Move the lamstwo.php file to moodle/lang/en_utf8/
# Login as admin and go to http://yourmoodle/admin, LAMS tables will be created automatically.
# Go to modules and click settings for LAMS2 module and put the proper values in, I used:
  server_url:    http://tecfasun1.unige.ch:8080/lams
server_id:      moodle
server_key:    somethingsecret
request_source: moodle


; On the LAMS side:
  #JBoss deploy directory (Unix)
* The integrated server setuhttp://wiki.lamsfoundation.org/display/lamsdocs/Homep is:
  server.home=/opt/wildfly
  Id:          moodle
  Key:          somethingsecret
Description:  TECFA Moodle
Prefix:      mdl
Organisation: moodle
User Information: URL: http://tecfax.unige.ch/moodle/mod/lamstwo/userinfo.php?ts=%timestamp%&un=%username%&hs=%hash%
Timeout URL:      http://tecfax.unige.ch/lams/timeout.html


; Notes
#Sass executable.
sass_exec_file=/usr/bin/sass


Make sure that you do not mix up case: E.g. if your group is called "moodle" in LAMS use "moodle" and '''not''' "Moodle" (I got stuck with this)
'''Copy the properties to file''' <code>build.properties</code>


Your JBOSS server may need '''yet more''' memory space allocated (see above)
'''Build LAMS'''


Be careful about using several browser windows and tabs. The "system Administration" page will use an already openend window/tab. So if the "Sys Admin" link doesn't bring up the tool, look for it...
It is not clear to me if one should build various components. In principle, lams-cruise alone should do the trick.


If you tried a Moodle LAMS integration in the past with an older LAMS server, your MOODLE may have junk left inside. Get rid of it (see next item).
# go to the build directory
cd /opt/lams/lams_build


; Problems
# Optional: build some stuff
ant build-db
ant deploy-ear   
ant deploy-tools


An error (for 2.1RC1) I was getting was:
# build lams (ant will read the build.xml file and "cruise" is a "target" that should build the whole thing)
  Could not add a new instance of lamstwo
ant lams-cruise
This happened after validating a LAMS activity in Moodle. In older version of the LAMS/Moodle mod something was wrong, I believe a missing table.


To fix this
At the end you should see something like:
* Delete the LAMS2 module in MOODLE.
lams-cruise:
* Remove the files in the mod directory
BUILD SUCCESSFUL
* Reinstall a '''new''' version (downloaded fresh).
Total time: 3 minutes 35 seconds


Now, in principle, LAMS is deployed in the Wildfly sever and could launch it again.


== LAMS 2.0 RC2 Windows XP PC ==
=== Compilation errors with OpenJDK 11 ===


Note: This chapter is outdated (written in Dec 2006). I don't see really the point in running a LAMS server on a personal PC and our servers are Unix.
Some library is missing with openjdk '''11''' and something else is wrong. I did not get these errors with Openjdk 8, but then I might have installed some extra libraries in the past. I cannot remember.


Do not try to install LAMS if you lack basic installation experience and technical '''reading skills'''. Here are just a few remarks in addition to the [http://wiki.lamsfoundation.org/display/lamsdocs/Windows+Installer+Help LAMS installation instructions]. I also strongly suggest to look at the [http://lamscommunity.org/dotlrn/clubs/technicalcommunity/forums/forum-view?forum_id=4929 Problems Installing LAMS] Forum.
    [echo] LAMS Common: Compiling Java sources
    [javac] Compiling 469 source files to /opt/lams/lams_common/build/classes/java
    [javac] warning: [options] bootstrap class path not set in conjunction with -source 8
    [javac] /opt/lams/lams_common/src/java/org/lamsfoundation/lams/policies/dao/hibernate/PolicyDAO.java:22: error: package com.sun.webkit does not exist
    [javac] import com.sun.webkit.PolicyClient;
    [javac]                      ^
    [javac] Note: Some input files use or override a deprecated API.
    [javac] Note: Recompile with -Xlint:deprecation for details.
    [javac] Note: Some input files use unchecked or unsafe operations.
    [javac] Note: Recompile with -Xlint:unchecked for details.
    [javac] 1 error
    [javac] 1 warning


=== Other Software ===
=== Test running LAMS with WildFly ===


To run it on windows you need to install other software.
Make sure that the port that you plan to use with WildFly is free. By default the standalone server version is port 8080.
* Java JSE 5.0 (update 9), ''not just the JRE''. Get it from [http://java.sun.com/javase/downloads/index.jsp Sun].
* MySQL: Get it directly from [http://dev.mysql.com/downloads/ MySQL] and take the '''Installer version''' (not the zip installation).
** Install it and remember the password
** I suggest '''not''' installing/using a [[WAMP]] environment for LAMS 2RC 2. The LAMS installer 2Rc2 could not find MySQL in my WampServer environment even if it was told where to look for in the LAMS installer.
** Hack would be to manually edit the registry with this [http://dev.mysql.com/doc/refman/5.0/en/windows-install-wizard.html information] from MySQL AB and [http://lamscommunity.org/dotlrn/clubs/technicalcommunity/forums/message-view?message_id=118753 this posting] and [http://lamscommunity.org/dotlrn/clubs/technicalcommunity/forums/attach/download/win_registry_msql%2ejpg?object_id=118756&attachment_id=118758 picture] by Ernie Ghiglione. Basically one needs to reproduce the MySQL entry from the official MySQL AB installer:
HKEY_LOCAL_MACHINE
  SOFTWARE
    MySQL AB
      MySQL Server 5.0 
                          Location c:\wamp\mysql
                          Version  5.0.27
... but this still didn't work for me. Something I did not try was to add mysqladmin.exe to the bin directory which is missing (see: [http://lamscommunity.org/dotlrn/clubs/technicalcommunity/forums/message-view?message_id=341725 Jun-Dir Liew]'s question and try it ... I don't have the time to do it right now. E.g. this file may be part of the simple zip / no registry version from the MySQL site).


=== MySQL ===
#Now test
cd /opt/wildfly/bin
./standalone.sh


* If you use a WAMP package you must know where MySQL sits. E.g. c:\wamp\mysql if you work with "WampServer" (but see above that I failed, rather work with an "official MySQL installer from MySQL AB). If you use the official MySQL installer, there will be no problem.
This will take some time since it will have to digest LAMS.


=== LAMS ===
# If your X server works and if you got Firefox installed on the server machine you can see something on the server.
firefox --new-instance
http://localhost:8080


* Make sure that the LAMS port (8080) is free, e.g. install [http://www.download.com/Active-Ports/3000-2085_4-10062969.html Active Ports] or type something like ''netstat -a'' in a DOS terminal.
'''Shutting down the test server'''


* LAMS has an installer and if you got the above right it will install without problems. You may have a firewall. In this case make sure to open the necessary ports. Also pay attention to popup blockers in your navigator. LAMS worked fine with both IE 6 and Firefox 1.5x.
* CTRL-C in the console
 
Else if you ran it as background process:
jboss-cli.sh --connect --command=:shutdown


== Documentation and using LAMS ==
== Documentation and using LAMS ==


This page is not a resource for endusers like course designers or learners. See:
'''Attention''': This wiki page is not a resource for end users like course designers or learners. Instead see:
 
* [http://wiki.lamsfoundation.org/display/lamsdocs/Home LAMS documentation Wiki Home]
* [http://wiki.lamsfoundation.org/display/lamsdocs/Home LAMS documentation Wiki Home]
* [[LAMS]] (this wiki)
* [[LAMS]] (this wiki)


; General
; Official LAMS 2 installation documentation
 
* [http://wiki.lamsfoundation.org/display/lamsdocs/Installing+MySQL+on+Windows+for+LAMS Installing Windows for LAMS] (also includes important MySQL configuration information)
 
* [http://wiki.lamsfoundation.org/display/lamsdocs/Integrations LAMS & LMS Integrations]
 
* [http://wiki.lamsfoundation.org/display/lamsdocs/Unix+Installer+Help Unix Installation and Updating Help] (if you plan to use the unix installer)
 
; Lams Moodle integration
 
* [http://docs.moodle.org/en/Category:LAMS Category:LAMS in the Moodle Wiki]
* [http://docs.moodle.org/en/Category:LAMS Category:LAMS in the Moodle Wiki]


; LAMS 1 (you rather should use LAMS 2)
* [http://wiki.lamsfoundation.org/display/lamsdocs/LAMS+v2.0+Integration+Setup+Step-by-Step+Guide LAMS v2.0 Integration Setup Step-by-Step Guide]
* [http://www.linuxtraining.org.uk/blogger1.html LAMS installation on CentOS 4 (RHEL 4)] (LAMS 1.x)
* [http://lamsfoundation.org/integration/moodle/walkthru.html LAMS and Moodle Integration Walkthrough] (LAMS 1.x)
 
; LAMS 2
* [http://wiki.lamsfoundation.org/display/lamsdocs/LAMS+v2.0+Integration+Setup+Step-by-Step+Guide LAMS v2.0 Integration Setup Step-by-Step Guide]
* [[LAMS]]


; Trouble shooting
; Trouble shooting
* [http://lamscommunity.org/dotlrn/clubs/technicalcommunity/ Technical community - Forums]
* [http://lamscommunity.org/dotlrn/clubs/technicalcommunity/ Technical community - Forums]


[[Category: Educational technologies]]
[[Category: Installation tips]]
[[Category: Installation tips]]

Latest revision as of 01:55, 16 November 2021

Definition

This page contains installation tips for a fresh install of LAMS.

LAMS is a JAVA/JBOSS-based application and needs some installation skills on Windows and good installation skills for Unix.

Note: I put the legacy stuff in the discussion page, e.g. LAMS 2.x for Ubuntu, LAMS 2.1RC for Solaris

LAMS 4.5+

As of July 2021, LAMS 4.5 was released and is the latest stable release.

Getting the LAMS source code

Source code is available from Github. The code branch to use is v4.5

Required software

  • Git
  • Wildfly 14.0.1
  • OpenJDK 11
  • MySQL 8.0
  • Ant (Java task compiler)

OpenJDK 11

In Debian/Ubuntu 20.04

$ sudo apt install openjdk-11-jdk-headless
$ sudo apt install fontconfig

MySQL 8.0 DB

$ wget https://dev.mysql.com/get/mysql-apt-config_0.8.15-1_all.deb
$ sudo dpkg -i  mysql-apt-config_0.8.15-1_all.deb
$ sudo apt update
$ sudo apt install mysql-server
$ sudo mysql_secure_installation
Basic MySQL configuration

/etc/mysql/mysql.conf.d/mysqld.cnf

...
# LAMS stuff
explicit_defaults_for_timestamp
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci
transaction-isolation=READ-COMMITTED
sql-mode="STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"
max_allowed_packet=32M
# Record slow queries
slow_query_log = 1
slow_query_log_file = /var/log/mysql/mysql-slow.log
long_query_time = 10

[mysqldump]
default-character-set=utf8mb4
hex-blob=1
single-transaction=1
quick=1
...

After installing MySQL, create a user and a DB for LAMS and grant appropriate permissions:

DROP DATABASE IF EXISTS lams;
CREATE DATABASE lamsdb DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci;
SET FOREIGN_KEY_CHECKS=1;
GRANT ALL PRIVILEGES ON lamsdb.* TO lamsdbuser@localhost IDENTIFIED BY 'real_secret_pw';
REVOKE SUPER ON *.* from lamsdbuser@localhost;

Wildfly 14.0.1

$ wget https://download.jboss.org/wildfly/14.0.1.Final/wildfly-14.0.1.Final.tar.gz
$ cd /opt/lams
$ tar xvzf wildfly-14.0.1.Final.tar.gz

LAMS source code pre-compilation

LAMS is open source and its code is available from GitHub

git clone https://github.com/lamsfoundation/lams.git

By default branch is LAMS' latest stable release as of July 2021, that's version 4.5. If you need a previous branch, see other branches available.

Wherever you have your LAMS v4.5 code, edit the following files

common.properties

Primarily the DB settings and based system.

If you are building LAMS using Windows, set the osPropertiesName to "windows" instead of "unix".

... 
#======== DATABASE PROPERTIES =========
db.host=localhost
db.port=3306
db.name=lamsdb
db.username=lamsdbuser  
db.password=real_secret_pw
...
osPropertiesName=unix
... 

If you are building LAMS in a unix based system, then change the file unix.properties. If you are using Windows, then change the windows.properties file instead.

unix.properties

Here you will need to figure a path to the content repository contentrepository.base=/var/opt/lams

The path to your Wildfly folder server.home=/usr/local/wildfly-14.0.1/

... 
contentrepository.base=/var/opt/lams 
... 
server.home=/opt/lams/wildfly-14.0.1/
... 

Compilation and deployment

cd lams_build
ant deploy-lams 

If no errors occurred, you are ready to start Wildfly.

cd /opt/lams/wildfly-14.0.1/bin
./standalone.sh


LAMS should be available at localhost:8080/lams/

By default, LAMS has a set of preconfigured users:

Default Users
user password role
sysadmin sysadmin System administrator
test1 test1 Teacher, student, tutor
test2 test2 Teacher, student, tutor
test3 test3 Teacher, student, tutor
test4 test4 Teacher, student, tutor

Of course, you can create and import users and courses into LAMS at any time from the sysadmin menu.

(OPTIONAL) Wildfly comes with a ton of libraries that LAMS does not use. So to slim Wildfly to only use the libs that LAMS uses, please run the following ant task in the lams_build folder:

ant slim-standalone

LAMS 3.1

As of March 2019, we do have a new LAMS installation that works fine in virtual server running Ubuntu 18.x.

However, I do not feel doing system administration anymore (except for this wiki) and I asked our systems person to do it. So there is not documentation, sorry.

Lams Moodle integration. There are two types of integration.

  • LAMS - Moodle integration with a Moodle plugin.
  • LTI integration, i.e. Moodle can "consume" LAMS contents

LTI external tool integration

Documentation

An administrator can manually configure external tools in Site administration > Plugins > Activity modules > External tool> Manage tools so that they are available across the site.

Moodle LAMS integration through a Moodle plugin

  • We did that with LAMS 2.5. To be tested with LAMS 3.0. There is a plugin for download and the method should be the same.

LAMS 3.0

As of November 2018, the current system is LAMS 3.x. You can test this with a demo version. Below, we started documenting an installation on Ubunt 18x, but we did not find time to complete the installation. As you can see something went wrong. Instead, we installed LAMS 3.1 on a virtual server machine.

History

LAMS 2.5 was initially promised for 2014. Then, after a funding cut, the LAMS team was mostly disbanded and the core team found a new "home" in Singapour. Sometimes in 2016 the version number was changed to LAMS 3.0.

Status as of Nov 2018

  • The old LAMS community pages are still online, but no longer maintained.
  • LAMS 3.x is available as commercial offering through Lams International and also through content services (to be verified).


Prerequisites

Java
Usually, this is installed. Check it. In principle, the Open JDK should work, however we do not know if that is true for older version. If it does not (we have to test) this, then it should be replaced with Oracle one. This is very likely the case.
java -version

gives something link:

openjdk version "10.0.2" 2018-07-17
OpenJDK Runtime Environment (build 10.0.2+13-Ubuntu-1ubuntu0.18.04.1)
OpenJDK 64-Bit Server VM (build 10.0.2+13-Ubuntu-1ubuntu0.18.04.1, mixed mode)

Installation did not work with java 11, so I tried OpenJDK version 8. If you don't have Java 8 (it already was on my system), install it first.

udo apt install openjdk-8-jdk
To use Java 8 by default, you can do the following. Most software seems to use Java 8 anyhow ....
sudo update-alternatives --config java


SASS (some kind of CSS pre-processor)
sudo apt install sass
Ant
sudo apt install ant
If exists, stop your old LAMS, e.g.
/etc/init.d/lams2 stop

Kill old LAMS

We did not try to upgrade an old LAMS installation since we did not have many sequences that were worthwhile keeping and since there are no instructions on how to do this. So, export sequences that are worth keeping ...

Remove the startup script for old lams (or similar if it exists)
grep -R lams /etc
For example
rm /etc/rc6.d/K02lams2
rm /etc/rc5.d/S02lams2
rm /etc/rc4.d/S02lams2
rm /etc/rc3.d/S02lams2
rm /etc/rc2.d/S02lams2
rm /etc/rc1.d/K02lams2
rm /etc/rc0.d/K02lams2

Install and configure Wildfly

# cd /src
wget http://download.jboss.org/wildfly/8.2.1.Final/wildfly-8.2.1.Final.tar.gz
tar xvfz wildfly-8.2.1.Final.tar.gz 
sudo mv /src/wildfly-8.2.1.Final /opt/wildfly
sudo chown you:you /opt/wildfly
cd /opt/wildfly
more README.txt   
#Now test
cd /opt/wildfly/bin
./standalone.sh
# If your X server works and if you got Firefox installed on the server machine
firefox --new-instance
http://localhost:9990

Create a new MySQL database and user

(1) Check what you got

mysqlshow -p -u root

(2) Create a new database and user

mysql -u root -p

and copy/paste an adapted version of the following

DROP DATABASE IF EXISTS lams3;  
CREATE DATABASE lams3 DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci; 
SET FOREIGN_KEY_CHECKS=1; 
GRANT ALL PRIVILEGES ON lams3.* TO lams@localhost IDENTIFIED BY 'real_secret_pw'; 
REVOKE PROCESS,SUPER ON *.* from lams@localhost;

After aborting wildfly you can run intot the following type of error (see also this, dated 07/14/10)

/opt/wildfly/bin$ 18:25:34,136 INFO  [JdbcMigrationLauncher]   If this isn't from a long-running patch, but a stale lock, either:
18:25:34,136 INFO  [JdbcMigrationLauncher]     1) run MigrationTableUnlock (probably 'ant patch.unlock')
18:25:34,136 INFO  [JdbcMigrationLauncher]     2) set the lockPollRetries property so the lock times out
18:25:34,136 INFO  [JdbcMigrationLauncher]        (this is dangerous in combination with long-running patches)
 18:25:34,136 INFO  [JdbcMigrationLauncher]     3) set the 'patch_in_progress' in the patches table to 'F'

In the LAMS DataBASE, run the following SQL

update patches set patch_in_progress = "F";

Dowload, configure and build LAMS

In order to find these files again, we decided to put them in /opt but any place can do.

sudo chown you:your_group /opt/lams 
cd /opt/
git clone https://github.com/lamsfoundation/lams.git

Edit the configuration files

cd /opt/lams/lams_build
  • Make a copy of the *.properties files just be sure. In addition, do not change the properties files themselves since they may be overridden by upgrades. Put them into a file called build.properties.

Change common.properties:

db.host=localhost
db.port=3306
db.name=lams3
db.username=lams.....
db.password=real_secret....

Change file unix.properties:

# Maybe not the best place for you, but at TECFA we always create a /data directory for data that must be kept, e.g. portalware, web server files, etc.
contentrepository.base=/data/lams
#JBoss deploy directory (Unix)
server.home=/opt/wildfly
#Sass executable. 
sass_exec_file=/usr/bin/sass

Copy the properties to file build.properties

Build LAMS

It is not clear to me if one should build various components. In principle, lams-cruise alone should do the trick.

# go to the build directory
cd /opt/lams/lams_build
# Optional: build some stuff
ant build-db
ant deploy-ear    
ant deploy-tools
# build lams (ant will read the build.xml file and "cruise" is a "target" that should build the whole thing)
ant lams-cruise

At the end you should see something like:

lams-cruise:
BUILD SUCCESSFUL
Total time: 3 minutes 35 seconds

Now, in principle, LAMS is deployed in the Wildfly sever and could launch it again.

Compilation errors with OpenJDK 11

Some library is missing with openjdk 11 and something else is wrong. I did not get these errors with Openjdk 8, but then I might have installed some extra libraries in the past. I cannot remember.

   [echo] LAMS Common: Compiling Java sources
   [javac] Compiling 469 source files to /opt/lams/lams_common/build/classes/java
   [javac] warning: [options] bootstrap class path not set in conjunction with -source 8
   [javac] /opt/lams/lams_common/src/java/org/lamsfoundation/lams/policies/dao/hibernate/PolicyDAO.java:22: error: package com.sun.webkit does not exist
   [javac] import com.sun.webkit.PolicyClient;
   [javac]                      ^
   [javac] Note: Some input files use or override a deprecated API.
   [javac] Note: Recompile with -Xlint:deprecation for details.
   [javac] Note: Some input files use unchecked or unsafe operations.
   [javac] Note: Recompile with -Xlint:unchecked for details.
   [javac] 1 error
   [javac] 1 warning

Test running LAMS with WildFly

Make sure that the port that you plan to use with WildFly is free. By default the standalone server version is port 8080.

#Now test
cd /opt/wildfly/bin
./standalone.sh

This will take some time since it will have to digest LAMS.

# If your X server works and if you got Firefox installed on the server machine you can see something on the server.
firefox --new-instance
http://localhost:8080

Shutting down the test server

  • CTRL-C in the console

Else if you ran it as background process:

jboss-cli.sh --connect --command=:shutdown

Documentation and using LAMS

Attention: This wiki page is not a resource for end users like course designers or learners. Instead see:

Official LAMS 2 installation documentation
Lams Moodle integration
Trouble shooting