How a new realm is being added

This document explains how to add a new realm to Yanel. We will explain this using the Yulup Website as an example. From now on, we will refer to the directories that contain Yanel and the Yulup website as $YANEL_HOME and $YULUP_WEBSITE .

  • Download the Yulup Website from Wyona's repository using subversion:
    svn co http://svn.wyona.com/repos/public/yulup/website
     (Username: anonymous, Password: anonymous)
  • Copy the file $YANEL_HOME/conf/realms.xml to $YANEL_HOME/conf/local/local.realms.xml and add the following entry:

    <realm id="yulup" mount-point="/yulup/">
    <name>Yulup Website</name>
    <config src="$YULUP_WEBSITE/yanel/config/yanel-realm-config.xml"/>
    </realm>

    <realm id="welcome" mount-point="/" root="true">
    <name>Yanel Welcome and General Administration</name>
    <config src="@REALMS_DIR@/welcome-admin/"/>
    </realm>

    NOTE for Windows users: Also use forward slashes, e.g. D:/realms/foo/yanel/config/yanel-realm-config.xml
  • Re-build Yanel
  • Re-start Yanel

Please note that the order of the realms doesn't matter. A request is being dispatched to the realm with the longest matching mount-point.

Also note that IIRC the root attribute (see the welcome realm configuration) is used for inheritance. For example, if a realm does not specify a proxy configuration, it will inherit this configuration from the root realm.

Some publicly available Third-Party realms


Your comments are much appreciated

Is the content of this page unclear or you think it could be improved? Please add a comment and we will try to improve it accordingly.