From: <jbo...@li...> - 2005-08-15 16:31:44
|
Author: aron.gombas Date: 2005-08-15 12:30:21 -0400 (Mon, 15 Aug 2005) New Revision: 860 Modified: trunk/labs/kosmos/xdocs/reference/reference-manual.xml Log: Deployment docs updated Modified: trunk/labs/kosmos/xdocs/reference/reference-manual.xml =================================================================== --- trunk/labs/kosmos/xdocs/reference/reference-manual.xml 2005-08-15 15:41:48 UTC (rev 859) +++ trunk/labs/kosmos/xdocs/reference/reference-manual.xml 2005-08-15 16:30:21 UTC (rev 860) @@ -675,7 +675,9 @@ portlets separately. Please note that however we listed recommended container implementations below, you can use any other product until that is compliant with the appropriate - servlet or portlet specifications.</para> + servlet or portlet specifications. You can learn more about + the compatibity issues by studying the compatibility matrix + maintained on the project website.</para> <para> @@ -683,6 +685,20 @@ <listitem> + <para>We offer deployment scripts in form of Ant build + scripts, which automatize the deployment process. If you + 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 + your environment. Even in this case, it's a good idea to + look through the deploy scripts.</para> + + </listitem> + + <listitem> + <para>The server component requires standard servlet containers (or a single container) for proper running. The containers must implement the TODO what? servlet @@ -784,6 +800,12 @@ separate database servers for this purporse. It's all up to 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, + 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> + </section> <section> @@ -826,52 +848,17 @@ <listitem> - <para>The deployment of the server component and the - portlets are similar. The binaries are not distributed as - WAR archives, because not only these, but additional - vendor-dependent configuration files must be deployed to - the container. It means that the WAR content actually - appears as extracted files which you have to copy to the - container-managed deployment directory.</para> - - <para> - - Server component deployment: - <orderedlist> - - <listitem> - - <para>Copy the <filename>kosmos-portal.war</filename> - directory from the distributed package to your JBoss - deployment directory (e.g. <filename> - $JBOSS_ROOT/server/default/deploy</filename>).</para> - - </listitem> - - <listitem> - - <para>Copy the configuration files from the <filename> - conf/jboss-portal</filename> directory of the - distributed package to the <filename> - WEB-INF</filename> directory in your JBoss deployment - directory (e.g. <filename> - $JBOSS_ROOT/server/default/deploy/kosmos-server.war/WEB-INF</filename>).</para> - - </listitem> - - </orderedlist> - + <para>Run the server deploy script as: + <programlisting>ant -f deploy-server-jboss-as.xml</programlisting> </para> </listitem> <listitem> - <para>Portlet deployment: it is same like the previous - step, but you have copy the <literal> - kosmos-portlet.war</literal> directory and the - configuration files go to <filename> - $JBOSS_ROOT/server/default/deploy/kosmos-portlet.war/WEB-INF</filename>.</para> + <para>Run the portlet deploy script as: + <programlisting>ant -f deploy-portlet-jboss-portal.xml</programlisting> + </para> </listitem> @@ -879,8 +866,8 @@ <para>Lauch 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 - there.</para> + whether you can see the <literal>Kosmos</literal> page + in the page list.</para> </listitem> @@ -894,7 +881,7 @@ <section> - <title>Deployment step-by-step for Apache Pluto</title> + <title>Deployment step-by-step for Apache Tomcat and Apache Pluto</title> <para> @@ -903,30 +890,38 @@ <listitem> - <para>TODO what to do with the server component? - </para> - - </listitem> - - <listitem> - <para>Install Pluto 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> + You can find Pluto at <ulink url="http://portals.apache.org/pluto"> + http://portals.apache.org/pluto</ulink> site.</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> + </para> + + </listitem> + + <listitem> + <para>Pluto has a portlet 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 your portlets, otherwise your new portal page won't appear in the - menu!</para> + 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: + <programlisting>ant -f deploy-portlet-pluto.xml</programlisting> + </para> + </listitem> @@ -938,7 +933,7 @@ <section> - <title>Deployment step-by-step for Sun Server Portal</title> + <title>Deployment step-by-step for Sun Java System Portal Server</title> <para>TODO write this later</para> |