4.2. webapp/WEB-INF/

Here you find the configuration files to enable-disable course building blocks,

APP.xml

Usually you have not to care about this file, except if you intend to use shibboleth. It is to configure the AttributeAcceptancePolicy used for Shibboleth authentication.

blacklist.txt

Regular expressions of user names which are not allowed, e.g. .*admin.*. Change it to match your requirements.

log4j.properties.in

Configuration for log4j, see also the documentation there. This is used for debugging problems.

olat_buildingblocks.xml

The course in OLAT consists of building blocks. You define the building blocks for your instance in this file, e.g. which id is matched to which implementing class. The list of building blocks available in your instance is defined in the section called “olat_extensions.in”.

olat_config.in

The olat.config.in file is well documented, you should read there what and how to set the values in these OLAT modules. Make sure that you run ant config-all copy-resources and also restart tomcat to activate the changes. Be aware that the order of the modules is relevant.

Caution

This configuration file will be clean-up and maybe disappear within the next releases. The modules/components/service configuration will then be found in single configuraiton files. See Section 4.3, “webapp/WEB-INF/src/serviceconfig”

The following list summarizes the modules which can be found there, with some keywords:

  • olatcontext

    Different basic settings like user data directory, instance id, mailhost, admin e-mails

  • module:org.olat.core.util.i18n.I18nManager

    enabled languages, default language, fallback language, translation server configuration

  • module:org.olat.core.commons.taskExecutor.TaskExecutorModule

    Task pool size

  • module:org.olat.core.commons.modules.bc.FolderModule

    Upload limit, Default quota, OLAT system folder root

  • module:org.olat.commons.servlets.StaticsModule

    Caution

    deprecated

  • module:org.olat.core.commons.persistence.DBModule

    Databaseconnection, configuration of connectionpool,

  • module:org.olat.commons.cluster.ClusterModule

    Caution

    not for production yet - will be available with OLAT 6.1.x Release

  • module:org.olat.admin.AdminModule

    Maximal concurrent websessions to be served by this instance.

  • module:org.olat.basesecurity.BaseSecurityModule

    Policies applied to the user manager role.

  • module:org.olat.registration.RegistrationModule

    Self registraton on/off, send info mail on registration, disclaimer html file for the different languages.

  • module:org.olat.login.LoginModule

    Number of Login attempts, if guests are allowed, list of login possibilities like OLAT, Shibboleth, etc.

  • module:org.olat.shibboleth13.ShibbolethModule

    Shibboleth configuration, attribute translation map, shibboleth attributes to olat userfield mapping

  • module:ch.goodsolutions.olat.jmx.JMXModule

    Caution

    Deprecated

  • module:org.olat.user.UserModule

    Default users which are generated. If users can change their password.

  • module:org.olat.course.CourseModule

    Course logging on/off, which logs are available for the author role, course to be deployed on startup

  • module:org.olat.instantMessaging.InstantMessagingModule

    Instant messaging server settings, enable chatrooms for learning groups and/or groups, in ajax mode the idle polling interval defines the interval for looking if a new message has arrived - the chat poll interval defines the refresh rate of the chat GUI during chatting.

    Caution

    Polling increases the load to the server and you should play with the values to find your optimal settings. The Server at university zurich with up to 700 concurrent users is fine with idle:15000ms and chat:2500ms

  • module:org.olat.notifications.NotificationsModule

    If notifications of changes like new forum posts, wiki pages, should be sent by e-mail and when it occurs.

  • module:org.olat.search.service.SearchModule

    If indexer should run, blacklist of files not to be included, maximum file size to index.

  • module:org.olat.repository.delete.service.DeletionModule

    User deletion packs away the data of a user to a directory specified here, defines a user name which receives the responses from users to you-are-about-to-be-deleted email.

  • module:org.olat.dispatcher.CatalogExportModuleDispatcher"

    DISABLED by default, this is a contribution of BPS Bildungsportal Sachsen GmbH. This allows to fetch the catalog as an XML file with direct course activation links.

olat_extensions.in

There are several extension points defined where you can hook in. You reference your extensions here, or you can disable some of the OLAT functionality which is realized as extensions. The course building blocks are realized as extension for example.

  • extmanager

    The generic extension may appear anywhere, typically as a menu entry or additional tab.

  • olatsites

    The olatsites lists the possible tabs like Home or Learn resources.

  • bbfactory

    List of building blocks available. Added here, and your building block appears in the course editor for insertion and configuration. If you remove building blocks, make sure you do not deploy example courses containing those building blocks. You have to remove them from your instance before changing the configuration, and also remove it from webapp/examples .

  • webdavfactory

    Each defined webdav provider defines a mount point under olat webdav access, and provides access to a resource.

  • olat_portals.xml

    This import the olat_portals.xml which is also seen as an extension possibility, see the section called “olat_portals.in” for more details.

olat_portals.in

The place where the users home and guest home is defined, but its generic in a way that you can define a new portal.

  • portletfactory

    A portal consists of one or more portlets. You define here all available portlets.

  • portalfactory

    In OLAT there is the homeportal and the guestportal defined. You can change here the default values or add your own portal

olat_upgrades.xml

The configured classes get executed in the given order. They are used for automatically update from version to version. Most probably you will never change something here.

web.xml.in

Configuration file used for servlet container, for more information see wikipedia:web.xml. It contains the configuration for the servlets and MIME mappings

  • org.olat.core.servlets.OLATServlet

  • org.olat.core.servlets.SecureWebdavServlet

  • org.olat.commons.servlets.RSSServlet

treecache.xml.in

This configures the jbossTreecache which is used in the cluster environment toghether with hibernate as a distributed cache for the hibernate queries. For more informations see: Jboss website.