LAMS 2.1 - Learning Activity Management System Upgrader -------------------------------------------------------------------------------- This is an upgrader package for LAMS 2.0.4 to LAMS 2.1. Please read this document carefully before upgrading and make sure that you have a valid installation of LAMS 2.0.4 on your machine. Please also ensure that you have read and understood the terms of the license agreement. CONTENTS ======== 1) Required Software 2) Installation 3) Languages and Locales 4) Server Configuration 5) Startup and Shutdown 6) Backing up LAMS 7) Web Resources 1. Required Software ==================== You will require some software to be installed and/or running for LAMS 2.1 to install and run properly. These are listed below LAMS 2.0.4 JDK 1.5 or 1.6 JBOSS-4.0.2 (Must be 4.0.2, newer and older versions have problems running LAMS) MySql 5.0.x (Running) Wildfire (Running - Required if you want to use chat tools) ANT - Included in this package 2. Installation =============== There are a few steps to updating LAMS on your computer. Firstly you must edit the lams.properties file (located in the root directory of the package) to comply with the settings you want for your computer. If you have retained the lams.properties file from a previous install, you can just replace the given lams.property with your previously edited one. Open the lams.properties file in a text editor and follow the instructions to alter the settings. The default settings are in the lams.properties file already so you need not change a lot. Pay particular attention to the Installation Options section and the Essential settings section. Take note that the majority of the projects in lams.ear for instance lams-central.war and lams-common.jar, if you have made changes to any projects, ensure that you back them up so you can re-apply them after the update. Before you run the script, you need to ensure that your $JAVA_HOME is set to your java 1.5 or higher directory, also you will need to set the $PATH variable to include the path to the java binaries. The steps to do this are listed below. > JAVA_HOME="(path to java installation directory)" > export JAVA_HOME > PATH="(path to java bin directory):$PATH" > export PATH Once you have finished editing lams.properties file you are ready to run the update script. Go to the root directory of the package and type: > sudo ./update-lams.sh Follow the prompts in the install script. The installer will ask you whether you want to stop LAMS before updating. Unless you have already done so yourself, it is HIGHLY RECOMMENDED that you let the upgrader run the shutdown script for LAMS, otherwise the upgrade will not run correctly. Also it is recommended that you backup LAMS before the upgrade, the upgrade script gives you this option, or you are also free to do so yourself. NOTE: If you are installing an production server, It is strongly recommended that you remove the jmx-console web applications as they can be a security risk. To do so, remove the jboss-4.0.2/server/default/management directory and the jboss-4.0.2/server/default/jmx-console.war diectory. 3. Languages and Locales ======================== In LAMS 2.1 you can set the defualt language of your server to be one of many languages, and more to come, see http://lamscommunity.org Look out for unix language packs to add to your list of language locales The locale options for LAMS 2.1 available are listed below, simply put in your lams.properties file (under Installation Options): LOCALE - (locale) LOCALE_DIRECTION - (locale direction) Language Locale Locale-Direction ------------------------------------------------ English (Australia) en_AU LTR Español (Spanish) es_ES LTR Deutsch (German) de_DE LTR 简体中文 (Chinese Simplified) zh_CN LTR Français (French) fr_FR LTR Italiano (Italian) it_IT LTR Norsk (Norwegian) no_NO LTR Svenska (Swedish) sv_SE LTR 한국어 (Korean) ko_KR LTR Polski (Polish) pl_PL LTR Português (Portuguese Brazil) pt_BR LTR Tiếng Việt (Vietnamese) vi_VN LTR Chinese (Taiwan) zh_TW LTR Arabic (عربي) (Jordan) ar_JO RTL Ελληνικά (Greek) el_GR LTR 4. Production Server Configuration ============================ For single user installations, (i.e. personal use on your desktop), please ignore this section - LAMS should run fine using the default settings. You may need to increase the limit for database connections, this can be done at (jboss directory)/server/default/deploy/mysql-ds.xml. Set the max-pool-size option to what you want, but it must be less than or equal to the max connections in mysql-Xms If your server starts reporting out of memory errors in the JBoss server.log file, you may need to increase the JVM memory settings for your server. This can be altered in the (jboss directory)/bin/run-lams.sh script. More information can be found at: http://wiki.lamsfoundation.org/display/lamsdocs/Production+Server+Settings 5. Startup and Shutdown ======================= To start LAMS 2.1 go to (jboss directory)/bin and type: >sudo ./run-lams.sh After a couple of minutes LAMS 2.1 will have started. In your browser type the server URL that you specified in the lams.configuration file, and you should be at the lams homepage. To shutdown LAMS 2.1 go to (jboss directory)/bin and type; > sudo ./shutdown.sh -S LAMS 2.1 will take a few moments to shut down. To check if LAMS 2.1 has shut down correctly, type the following on Linux: > ps -ef | grep java Or type the following on Macintosh > ps -A | grep Java If you aren't sure which version of 'ps' to use, try the '-ef' version and if that gives and error 'ps: illegal option --f" then try the -A version. If you can see the LAMS 2.1 process still running, type: > sudo kill (pid) Where pid is the process id listed next to the LAMS 2.1 process Be careful to type the correct (pid). If you type the wrong number, you will stop another process on your server, and as you are using sudo you could stop an important process! 6. Backing up LAMS ================== To backup your LAMS installation manually, simply follow the following steps 1) Backup your jboss-4.0.2 directory where LAMS is installed (/usr/local/jboss-4.0.2 by default) 2) Backup your uploaded file repositories (/var/opt/lams by default) 3) Backup /etc/lams2 4) Dump the database by executing the following command. Fill in your own backup directory /mysqldump -u -p > /dump.sql 7. Web Resources ================ Unix Installer help wiki http://wiki.lamsfoundation.org/display/lamsdocs/Unix+Installer+Help LAMS 2.1 developer-oriented information http://wiki.lamsfoundation.org/display/lams LAMS 2.1 help documents http://wiki.lamsfoundation.org/display/lamsdocs Educational and technical forums for help and discussion http://www.lamscommunity.org LAMS 2.1 bug tracker https://bugs.lamsfoundation.org LAMS Foundation http://www.lamsfoundation.org