The following instructions will help you set up your learning environment.
Before you start, you should get the deployable .war packages of Valamis from us at email@example.com.
For Linux, make sure you have the
libudev library, as well.
1. Install Java
First of all, you should have Java installed. The Oracle Java version 8 is required.
2. Set up a database management system and create a database for Liferay
You need to set up a database, as the default one is not suitable.
PostgreSQL is recommended, but any kind of database management system should work. Once you've installed the system, set up a database and username there.
3. Download Liferay
There are two versions of Liferay that you can use with Valamis: Liferay 6.2 and Liferay 7.
Currently supported versions:
Liferay Portal 6.2 CE GA1+
Liferay Portal 6.2 EE GA1+
Liferay DXP 7.0 SP4 or SP6.
4. Configure Tomcat's memory usage
Before you start up your Liferay, modify Tomcat's memory settings.
- Go to your /liferay-xx/tomcat-xx/bin folder.
- Open your setenv.sh (or setenv.bat if you are using Windows) with a text editor.
- Find the following part: Xmx1024m -XX:MaxPermSize=256m
- Modify it to Xmx2048m -XX:MaxPermSize=512m
- Save the file
5. Configure the portal-ext.properties settings
In order for Message Boards and Valamis Assignments portlets to work properly, add the following lines to portal-ext.properties:
1) If the environment has a virtualhost
2) If the environment doesn't have a virtualhost
If you use a frontend server, like Apache or Nginx, add the following lines to portal-ext.properties:
6. Start up your Liferay
- Tomcat starts by /liferay-xx/tomcat-xx/bin/startup.sh (startup.bat on Windows).
- You can monitor its server log in /liferay-xx/tomcat-xx/logs/catalina.out
- Once your Tomcat is up and running, it will open a browser with the Liferay's startup page. Alternatively, you can access it through the port 8080, e.g. http://localhost:8080
- On the startup page, finish your configuration. Don't forget to set the database type, name, username, and password according to what you did in step 2.
7. Download and deploy Valamis
Download Valamis for your Liferay version:
- You can deploy Valamis on top of the running Liferay. (Liferay runs on Tomcat, Valamis runs on Liferay).
- To do so, copy the downloaded .lpkg file into the /liferay-xx/deploy folder.
- Liferay will now deploy Valamis application.
Note: deployed Valamis will have an LRS (learning record store), theme, portlets and a hook.
8. Get licensed
- Log into your portal and find the Valamis Administration portlet in the Site Administration -> Content tab.
- You can see your hardware ID there, which you will need in order to acquire the license. You can either get a trial license or receive a full license from our managers.
- You can find information about licensing here.
9. Valamis is now ready to use
You can now use Valamis, but you may want to configure some things, first.
10. Set up Competences and Training events
You need to set up Competences portlets to work properly for normal users. To do so:
1) For Liferay DXP, in the Competences Administration portlet, go to Configuration -> Scope, and set the Scope to Global.
2) For Liferay DXP and Liferay 6, click the Permissions button, find the User role and check at least the following permissions: Create competence, Create goal, Create experience.
Known issue: in Liferay 6.2, in order to save calendar permissions in Training events, you need to:
1) Set the permissions as needed, then Save.
2) Go to Control Panel -> Server Administration.
3) Find Clean up permissions and click Execute.
11. Set up permissions for Courses
Due to the way this system works in Liferay, when you create a new course in Course Manager, it is important that you set the relevant permissions for needed roles, especially, View for the User role. Otherwise, the newly created site will not be visible in Course Browser's Available Courses tab.
1) Go to Control Panel -> Users -> Roles.
2) Find the User role, and click Define permissions in the Actions menu.
3) In the permission sidebar, navigate to Control Panel > Sites > Sites.
4) In the Resource Permissions, check the View permission. Save your changes.
12. Initialize lesson publishing
Add Lesson Manager to any page to initialize lesson publishing. You can later delete Lesson Manager from the page if you don't need it.
13. Configure the mail
- Go to Control Panel -> Server Administration -> Mail tab
- Fill the Outgoing SMTP Server and Outgoing Port fields according to your needs.
14. Configure Antisamy
In order for links and embedded elements to work properly, you need to set up Liferay Antisamy.
1) Go to Control Panel -> Configuration -> System Settings -> Foundation -> AntiSamy Sanitizer
2) Add a new element to the whitelist:
15. Configure your own LRS (optional step)
- If you use your own LRS, you can configure it in the Valamis Administration's Tincan settings tab. Read about it here.
16. Configure the Google API (optional step)
- In order to use the contents of Google Drive and Youtube in the Lesson Studio, you need to configure the Google API.
- You can find further information here.
17. Configure PowerPoint import (optional step)
- If you're planning to import PowerPoints to your environment, please check this PowerPoint import configuration guide.
18. Configure Liferay Search portlet (optional step)
- If you're planning to import PowerPoint presentations to your environment as Valamis lessons, you need to take the steps described here.