[Yanel-commits] rev 57641 - public/yanel/trunk/src/realms/yanel-website/data-repo/data/en/documentation

[ioannis at wyona.com]

Author: ioannis
Date: 2011-04-01 13:23:29 +0200 (Fri, 01 Apr 2011)
New Revision: 57641

Modified:
   public/yanel/trunk/src/realms/yanel-website/data-repo/data/en/documentation/how-to-add-a-new-realm.html
Log:
Added a small note to the documentation about the usage of the -Drealm-config= parameter

Modified: public/yanel/trunk/src/realms/yanel-website/data-repo/data/en/documentation/how-to-add-a-new-realm.html
===================================================================
--- public/yanel/trunk/src/realms/yanel-website/data-repo/data/en/documentation/how-to-add-a-new-realm.html	2011-04-01 10:50:47 UTC (rev 57640)
+++ public/yanel/trunk/src/realms/yanel-website/data-repo/data/en/documentation/how-to-add-a-new-realm.html	2011-04-01 11:23:29 UTC (rev 57641)
@@ -22,6 +22,11 @@
   </li>
   <li>Navigate to $YANEL_HOME and run
     <pre>./build.sh add-realm -Drealm-config=$YULUP_WEBSITE/yanel/config/yanel-realm-config.xml -Drealm-mount-point=/yulup/ -Drealm-id=yulup<br/></pre>
+    <p>Note: Usually the realm configuration file is named "realm.xml" and saved in the realm root directory.<br/>
+    Yulup doesn't follow this convention, instead using a file named "yanel-realm-config" saved in "$YULUP_WEBSITE/yanel/config".<br/>
+    If you name the realm configuration file conventionally as "realm.xml" you can point the "-Drealm-config=" parameter to the directory that contains the file.<br/>
+    If you have a chosen a different name, please point that parameter explicitly to the file.
+    </p>
   </li>
   <li>Alternatively, you can add the realm node directly into $YANEL_HOME/conf/local/local.realms.xml. If you do not have this file, copy $YANEL_HOME/conf/realms.xml to $YANEL_HOME/conf/local/local.realms.xml first<br/>
     <pre><realm id="yulup" mount-point="/yulup/"><br/>  <name>Yulup Website</name><br/>  <config src="$YULUP_WEBSITE/yanel/config/yanel-realm-config.xml"/><br/></realm></pre>