From: <jbo...@li...> - 2005-08-21 07:52:15
|
Author: aron.gombas Date: 2005-08-21 03:52:08 -0400 (Sun, 21 Aug 2005) New Revision: 906 Modified: trunk/labs/kosmos/xdocs/reference/reference-manual.xml Log: Deployment guide updated to 0.1.0RC2 Modified: trunk/labs/kosmos/xdocs/reference/reference-manual.xml =================================================================== --- trunk/labs/kosmos/xdocs/reference/reference-manual.xml 2005-08-21 07:51:36 UTC (rev 905) +++ trunk/labs/kosmos/xdocs/reference/reference-manual.xml 2005-08-21 07:52:08 UTC (rev 906) @@ -727,7 +727,7 @@ <section> - <title>Deployment scenarios</title> + <title>Deployment models</title> <para> @@ -793,7 +793,7 @@ </para> - <para>You can complicate all the scenarios by another important + <para>You can complicate all the models by another important decision: what RDBMS to use to support the portlet container and how to deploy it. Again, it's possible to use the same physical node or nodes which host the containers, or to have @@ -801,7 +801,7 @@ you, your needs and possibilities.</para> <para>In the following sections, we give detailed step-by-step instructions - for various deployment scenarios, but because of their huge variety, + for various deployment models, but because of their huge variety, we will cover just some of those. After reading these, it should be relatively easy to find out what to do in situations not listed here. </para> @@ -810,6 +810,91 @@ <section> + <title>Deployment step-by-step for Apache Tomcat and Gridsphere</title> + + <para> + + Follow these steps: + <orderedlist> + + <listitem> + + <para>Install Gridsphere as written in its manual + (<ulink url="http://www.gridsphere.org/gridsphere/docs/UsersGuide/UsersGuide.html">http://www.gridsphere.org/gridsphere/docs/UsersGuide/UsersGuide.html</ulink>). + You can find Gridsphere at <ulink url="http://www.gridsphere.org"> + http://www.gridsphere.org</ulink>.</para> + + </listitem> + + <listitem> + + <para>Deploy Jakarta Slide to the Tomcat instance used by Gridsphere + as written in the JBoss AS step-by-step.</para> + + </listitem> + + <listitem> + + <para>You can deploy the server component into the Apache Tomcat + instance used by Gridsphere, by running the server deploy script: + <programlisting>ant -f deploy-server-tomcat.xml</programlisting> + Please don't forget to set the <literal>CATALINA_HOME</literal> + environment variable before. + </para> + + </listitem> + + <listitem> + + <para>Run the portlet deploy script as: + <programlisting>ant -f deploy-portlet-gridsphere.xml</programlisting> + As an additional step, copy <filename>$GRIDSPHERE_HOME/build/lib/gridsphere-ui-tags.jar</filename> + to <filename>$CATALINA_HOME/webapps/kosmos-portlet.war/WEB-INF/lib</filename>. + </para> + + </listitem> + + <listitem> + + <para>Lauch Gridsphere, open the default portal page + (e.g. <literal>http://localhost:8080/gridsphere</literal>), and + login with the default account (<literal>root</literal> + and empty password). After this, there are couple of extra steps + that you can do using the Gridsphere admin portlets: + + <orderedlist> + <listitem> + <para>Deploy <literal>kosmos-portlet</literal> manually. + </para> + </listitem> + + <listitem> + <para>Create a new public group <literal>kosmos</literal> + that contains all the Kosmos portlets and add your user + to this new group. + </para> + </listitem> + + <listitem> + <para>Go to your new page and add the Kosmos portlets + to this. + </para> + </listitem> + + </orderedlist> + + </para> + + </listitem> + + </orderedlist> + + </para> + + </section> + + <section> + <title>Deployment step-by-step for JBoss AS and JBoss Portal</title> @@ -881,6 +966,103 @@ <section> + <title>Deployment step-by-step for Apache Tomcat and Liferay Portal</title> + + <para> + + Follow these steps: + <orderedlist> + + <listitem> + + <para>Install Liferay Portal as written in its manual. We recommend + using the bundle distribution, because that contains both the + Apache Tomcat servlet container and the Liferay Portal portlet container + in a single package. + You can find Liferay at <ulink url="http://www.liferay.com/web/guest/products"> + http://www.liferay.com/web/guest/products</ulink>.</para> + + </listitem> + + <listitem> + + <para>Deploy Jakarta Slide to the Tomcat instance used by Liferay + as written in the JBoss AS step-by-step.</para> + + </listitem> + + <listitem> + + <para>You can deploy the server component into the Apache Tomcat + instance used by Liferay, by running the server deploy script: + <programlisting>ant -f deploy-server-tomcat.xml</programlisting> + Please don't forget to set the <literal>CATALINA_HOME</literal> + environment variable before. + </para> + + </listitem> + + <listitem> + + <para> + Hot-deploy the portlets as written at <ulink url="http://www.liferay.com/web/guest/documentation/development/hot_deploy">http://www.liferay.com/web/guest/documentation/development/hot_deploy</ulink>. + The portlet distribution package of Kosmos contains a customized version of + <filename>portlet-deployer-3.5.0.xml</filename> which you might find convenient + as starting point. + </para> + + <para> + There are a couple of issues you can face while starting up your Liferay, depending on your JVM version: + + <orderedlist> + + <listitem> + <para>You have to downgrade the <filename>$LIFERAY_HOME/webapps/kosmos-portlet/WEB-INF/lib/commons-logging-1.0.4.jar</filename> to <filename>commons-logging-1.0.3.jar</filename> (downloadable from <ulink url="http://www.ibiblio.org/maven/commons-logging/jars/">http://www.ibiblio.org/maven/commons-logging/jars/</ulink>) if Liferay throws a <literal>java.lang.NoSuchMethodError: org.apache.log4j.Category.log(Ljava/lang/String;Lorg/apache/log4j/Level;Ljava/lang/Object;Ljava/lang/Throwable;)V</literal> + </para> + </listitem> + + <listitem> + <para>You have to delete <filename>$LIFERAY_HOME/common/endorsed/lib/xml-apis.jar</filename> if Liferay throws a <literal>javax.servlet.ServletException: Provider org.apache.xalan.processor.TransformerFactoryImpl not found</literal> exception + </para> + </listitem> + + <listitem> + <para>You have to copy <filename>$LIFERAY_HOME/liferay/WEB-INF/tld/liferay-portlet.tld</filename> to <filename>$LIFERAY_HOME/webapps/kosmos-portlet/WEB-INF/tld</filename> if Liferay throws a <literal>org.apache.jasper.JasperException: /pages/sf_monitoring.jsp(1,1) File "/WEB-INF/tld/liferay-portlet.tld" not found</literal> or similar exception + </para> + </listitem> + + <listitem> + <para>You have to copy <filename>$LIFERAY_HOME/liferay/WEB-INF/lib/util-taglib.jar</filename> to <filename>$LIFERAY_HOME/webapps/kosmos-portlet/WEB-INF/lib</filename> if Liferay throws a <literal>org.apache.jasper.JasperException: /pages/sf_monitoring.jsp(1,1) Failed to load or instantiate TagExtraInfo class: com.liferay.portlet.taglib.ActionURLTei</literal> or similar exception + </para> + </listitem> + + </orderedlist> + + </para> + + </listitem> + + <listitem> + + <para>Lauch Liferay, open the default portal page + (e.g. <literal>http://localhost:8080</literal>), + login with the default account (<literal>te...@li...</literal> + and <literal>test</literal>) and check whether you can see the + Kosmos portlets selectable in the combox boxes at the bottom of + the portal pages.</para> + + </listitem> + + </orderedlist> + + It is possible also to hot-deploy the components while JBoss AS + is running. + </para> + + </section> + + <section> + <title>Deployment step-by-step for Apache Tomcat and Apache Pluto</title> <para> @@ -901,16 +1083,26 @@ <listitem> + <para>Deploy Jakarta Slide to the Tomcat instance used by Pluto + as written in the JBoss AS step-by-step.</para> + + </listitem> + + <listitem> + <para>You can deploy the server component into the Apache Tomcat instance used by Pluto, by running the server deploy script: <programlisting>ant -f deploy-server-tomcat.xml</programlisting> + Please don't forget to set the <literal>CATALINA_HOME</literal> + environment variable before. </para> </listitem> <listitem> - <para>Pluto has a portlet to deploy other portlets. It makes the + <para>Pluto has a portlet called <literal>Deploy War Admin Portlet</literal> + to deploy other portlets. It makes the deployment process extremely easy: just select the portlet WAR and configure the pages, Pluto will take care of all the low-level details. Don't forget to restart Pluto after you've deployed @@ -920,10 +1112,26 @@ <para>If for some reason you decided to do an automated deployment instead of using the administrative portlet, run the portlet deploy script as: <programlisting>ant -f deploy-portlet-pluto.xml</programlisting> + After this, you have to manually update the following Pluto configuration + files: + <simplelist> + <member><filename>pageregistry.xml</filename></member> + <member><filename>portletcontexts.txt</filename></member> + <member><filename>portletentityregistry.xml</filename></member> + </simplelist> + You can use the sample files found in <literal>/conf/pluto</literal> of the + Kosmos portlet distribution package as starting point. </para> - </listitem> + + <listitem> + <para> + Launch Pluto and check the default portal page + (e.g. <literal>http://localhost:8080/pluto/portal</literal>), + whether you can see your new page in the page list. + </para> + </listitem> </orderedlist> @@ -1016,35 +1224,6 @@ <section> - <title>I18n</title> - - <para>The server component is completely locale-agnostic, you - don't have to do anything there.</para> - - <para> - - Setting the preferred locale is simply a change in the - <filename>web.xml</filename> - of the portlet module. You just have to change the - context-param which configures the JSTL library: - <programlisting><context-param> - <param-name>javax.servlet.jsp.jstl.fmt.locale</param-name> - <param-value><emphasis>en</emphasis></param-value> -</context-param></programlisting> - This parameter accepts the standard Java locale signs as value, - but please make sure that the property file of the selected - language is available in your distribution. At the moment, the - supported locales are: English ( - <literal>en</literal> - ) and Hungarian ( - <literal>hu</literal> - ). - </para> - - </section> - - <section> - <title>General portlet configuration</title> <para> @@ -1207,6 +1386,35 @@ </section> + <section> + + <title>I18n</title> + + <para>The server component is completely locale-agnostic, you + don't have to do anything there.</para> + + <para> + + Setting the preferred locale is simply a change in the + <filename>web.xml</filename> + of the portlet module. You just have to change the + context-param which configures the JSTL library: + <programlisting><context-param> + <param-name>javax.servlet.jsp.jstl.fmt.locale</param-name> + <param-value><emphasis>en</emphasis></param-value> +</context-param></programlisting> + This parameter accepts the standard Java locale signs as value, + but please make sure that the property file of the selected + language is available in your distribution. At the moment, the + supported locales are: English ( + <literal>en</literal> + ) and Hungarian ( + <literal>hu</literal> + ). + </para> + + </section> + </chapter> <chapter> |