From: <jbo...@li...> - 2005-11-11 08:50:29
|
Author: aron.gombas Date: 2005-11-11 03:50:21 -0500 (Fri, 11 Nov 2005) New Revision: 1555 Modified: trunk/labs/kosmos/xdocs/reference/reference-manual.xml Log: "Deployment" section in the man rewritten Modified: trunk/labs/kosmos/xdocs/reference/reference-manual.xml =================================================================== --- trunk/labs/kosmos/xdocs/reference/reference-manual.xml 2005-11-11 07:00:55 UTC (rev 1554) +++ trunk/labs/kosmos/xdocs/reference/reference-manual.xml 2005-11-11 08:50:21 UTC (rev 1555) @@ -722,10 +722,11 @@ want to use these, you will need to install Ant. The default target of each script is <literal>redeploy</literal>, which deletes the old deployment (if there exists) and deploys a - new clean one. - Of course, you can still deploy manually if Ant is not available in + new clean one.</para> + <para>Of course, you can still deploy manually if Ant is not available in your environment. Even in this case, it's a good idea to - look through the deploy scripts.</para> + look through the deploy scripts and then to follow the + step-by-step guide provided in the next sections.</para> </listitem> @@ -733,30 +734,28 @@ <para>The server component requires standard servlet containers (or a single container) for proper running. - The most trivial option is to use the Apache - Tomcat container, which you can found at - <ulink url="http://jakarta.apache.org/tomcat"> - http://jakarta.apache.org/tomcat</ulink>.</para> + The most trivial option is to use the + <ulink url="http://jakarta.apache.org/tomcat">Apache Tomcat</ulink> container.</para> </listitem> <listitem> <para>The portlets needs a JSR-168-compliant portlet - container. One possible open source choice is JBoss Portal ( - <ulink url="http://www.jboss.org/products/jbossportal">http://www.jboss.org/products/jbossportal</ulink>) - deployed into a JBoss Application server instance ( - <ulink url="http://www.jboss.org/products/jbossas">http://www.jboss.org/products/jbossas</ulink>).</para> + container. One possible open source choice is + <ulink url="http://www.jboss.org/products/jbossportal">JBoss Portal</ulink> + deployed into a <ulink url="http://www.jboss.org/products/jbossas">JBoss Application server</ulink> + instance.</para> </listitem> <listitem> <para>For storing the dynamically generated content (e.g. chart - images), you need a WebDAV server implementation. One option - is to use Jakarta Slide (available at - <ulink url="http://jakarta.apache.org/slide">http://jakarta.apache.org/slide</ulink>), - but Subversion provides a WebDAV interface, too.</para> + images), you need a <ulink url="http://www.webdav.org/">WebDAV</ulink> server implementation. One option + is to use <ulink url="http://jakarta.apache.org/slide">Jakarta Slide</ulink>, + but <ulink url="http://subversion.tigris.org">Subversion</ulink> + provides a WebDAV interface, too.</para> </listitem> @@ -858,8 +857,11 @@ <listitem> - <para>Install eXo as written in its <ulink url="http://www.exoplatform.com/portal/faces/public/exo/home/community/wiki">documentation</ulink>. - You can find eXo at <ulink url="http://www.exoplatform.com">http://www.exoplatform.com</ulink>.</para> + <para>Install <ulink url="http://www.exoplatform.com">eXo Platform</ulink> + as written in its <ulink url="http://www.exoplatform.com/portal/faces/public/exo/home/community/wiki">documentation</ulink>. + We recommend using the bundle distribution, because that contains both the + Apache Tomcat servlet container and the eXo Platform portlet container + in a single package.</para> </listitem> @@ -884,7 +886,7 @@ <listitem> - <para>Run the portlet deploy script as: + <para>Deploy the portlet web application by running the portlet deployment script as: <programlisting>ant -f deploy-portlet-exo.xml</programlisting> </para> @@ -892,7 +894,7 @@ <listitem> - <para>Lauch eXo, open the default portal page + <para>Launch eXo, open the default portal page (e.g. <literal>http://localhost:8080/portal</literal>), and login with the default account (<literal>admin</literal> and <literal>exo</literal>).</para> Go to page <literal>edit</literal> mode @@ -918,8 +920,8 @@ <listitem> - <para>Install Gridsphere as written in its <ulink url="http://www.gridsphere.org/gridsphere/docs/UsersGuide/UsersGuide.html">manual</ulink>. - You can find Gridsphere at <ulink url="http://www.gridsphere.org">http://www.gridsphere.org</ulink>.</para> + <para>Install <ulink url="http://www.gridsphere.org">Gridsphere</ulink> as written + in its <ulink url="http://www.gridsphere.org/gridsphere/docs/UsersGuide/UsersGuide.html">manual</ulink>.</para> </listitem> @@ -933,7 +935,7 @@ <listitem> <para>You can deploy the server component into the Apache Tomcat - instance used by Gridsphere, by running the server deploy script: + instance used by Gridsphere simply 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. @@ -943,7 +945,7 @@ <listitem> - <para>Run the portlet deploy script as: + <para>Deploy the portlet web application by running 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>. @@ -953,11 +955,11 @@ <listitem> - <para>Lauch Gridsphere, open the default portal page + <para>Launch 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: + that you have to do using the Gridsphere admin portlets: <orderedlist> <listitem> @@ -1012,16 +1014,20 @@ <listitem> <para>Deploy <ulink url="http://jakarta.apache.org/slide">Jakarta Slide</ulink> to JBoss AS and configure it as - written in the appropriate manuals. Test if you can access - the Slide repositories through a WebDAV navigator. If you - use Windows XP, it is able to map a WebDAV repository as - a folder to your filesystem.</para> + written in the appropriate manuals. We have included the Slide web application archive (<filename>slide.war</filename>) + in the binary distribution package of Kosmos, under the <filename>/etc</filename> folder. + In most situations, it's enough to copy this file to the deployment folder + of the servlet container or the application server.</para> + <para>As a quick test, check whether you can access the Slide repositories through a WebDAV navigator. + If you use Windows XP, it is able to map a WebDAV repository as + a folder to your filesystem. Otherwise try to open the repository in your + browser using the <literal>http://localhost:8080/slide</literal> URL.</para> </listitem> <listitem> - <para>Install JBoss Portal as written in its manual. Test + <para>Install JBoss Portal as written in its manual. Check if there are no error messages in the JBoss AS logfile.</para> @@ -1037,7 +1043,7 @@ <listitem> - <para>Run the portlet deploy script as: + <para>Deploy the portlet web application by running the portlet deploy script as: <programlisting>ant -f deploy-portlet-jboss-portal.xml</programlisting> </para> @@ -1045,7 +1051,7 @@ <listitem> - <para>Lauch JBoss AS and check the default portal page + <para>Launch JBoss AS and check the default portal page (e.g. <literal>http://localhost:8080/portal</literal>), whether you can see the <literal>Kosmos</literal> page in the page list.</para> @@ -1071,12 +1077,10 @@ <listitem> - <para>Install Liferay Portal as written in its manual. We recommend - using the bundle distribution, because that contains both the + <para>Install <ulink url="http://www.liferay.com/web/guest/products">Liferay Portal</ulink> + 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> + in a single package.</para> </listitem> @@ -1090,7 +1094,7 @@ <listitem> <para>You can deploy the server component into the Apache Tomcat - instance used by Liferay, by running the server deploy script: + instance used by Liferay simply 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. @@ -1113,13 +1117,13 @@ <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>. - The same exception can be thrown also for the kosmos-servlet web-application, the fix is the same: downgrade the same JAR also in <filename>$LIFERAY_HOME/webapps/kosmos-server/WEB-INF/lib</filename>. + <para>You have to downgrade the <filename>$LIFERAY_HOME/webapps/kosmos-portlet/WEB-INF/lib/ext/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>. + The same exception might be thrown also for the kosmos-servlet and the kosmos-portlet web-applications, the fix is the same: downgrade the same JAR also in <filename>$LIFERAY_HOME/webapps/kosmos-server/WEB-INF/lib</filename> and <filename>$LIFERAY_HOME/webapps/kosmos-portlet/WEB-INF/lib</filename>, respectively. </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>You have to delete <filename>$LIFERAY_HOME/common/endorsed/xml-apis.jar</filename> if Liferay throws a <literal>javax.servlet.ServletException: Provider org.apache.xalan.processor.TransformerFactoryImpl not found</literal> exception </para> </listitem> @@ -1141,19 +1145,22 @@ <listitem> - <para>Lauch Liferay, open the default portal page - (e.g. <literal>http://localhost:8080</literal>), + <para>Launch Liferay, open the default portal page + (e.g. <literal>http://localhost:8080</literal>) and 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> + and <literal>test</literal>).</para> + <para>Open the portlet administration portlet and assign some + roles to the Kosmos portlets (e.g. <literal>User</literal> and + <literal>Guest</literal>). Also, set the JIRA and Subversion monitoring + portlets to <literal>wide</literal> style, all the others to + <literal>narrow</literal>. Create a new page or go to an existing page, + and check whether you can see the Kosmos portlets selectable in the + combo 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> @@ -1169,12 +1176,10 @@ <listitem> - <para>Install Pluto as written in its manual. We recommend - using the bundle distribution, because that contains both the + <para>Install <ulink url="http://portals.apache.org/pluto">Pluto</ulink> as written in its manual. + We recommend using the bundle distribution, because that contains both the Apache Tomcat servlet container and the Pluto portlet container - in a single package. - You can find Pluto at <ulink url="http://portals.apache.org/pluto"> - http://portals.apache.org/pluto</ulink> site.</para> + in a single package.</para> </listitem> @@ -1188,7 +1193,7 @@ <listitem> <para>You can deploy the server component into the Apache Tomcat - instance used by Pluto, by running the server deploy script: + instance used by Pluto simply 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. @@ -1207,7 +1212,7 @@ menu!</para> <para>If for some reason you decided to do an automated deployment - instead of using the administrative portlet, run the portlet deploy script as: + instead of using the administrative portlet, deploy the portlet web application by running 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: |