[portal-commits] JBoss Portal SVN: r8197 - in docs/trunk/referenceGuide/en: modules and 1 other directory.

Author: thomas.heute(a)jboss.com Date: 2007-09-07 10:36:29 -0400 (Fri, 07 Sep 2007) New Revision: 8197 Added: docs/trunk/referenceGuide/en/images/setup/build_deploy.png docs/trunk/referenceGuide/en/images/setup/build_ds.png docs/trunk/referenceGuide/en/images/setup/build_ds_dir.png docs/trunk/referenceGuide/en/images/setup/dsfiles.png docs/trunk/referenceGuide/en/images/setup/package.png docs/trunk/referenceGuide/en/images/setup/svncodir.png Removed: docs/trunk/referenceGuide/en/images/setup/build_deploy.gif docs/trunk/referenceGuide/en/images/setup/build_ds.gif docs/trunk/referenceGuide/en/images/setup/build_ds_dir.gif docs/trunk/referenceGuide/en/images/setup/deploy_dir.gif docs/trunk/referenceGuide/en/images/setup/dsfiles.gif docs/trunk/referenceGuide/en/images/setup/inst_fin.gif docs/trunk/referenceGuide/en/images/setup/inst_lang.gif docs/trunk/referenceGuide/en/images/setup/inst_localhost.png docs/trunk/referenceGuide/en/images/setup/inst_name.gif docs/trunk/referenceGuide/en/images/setup/inst_packs.gif docs/trunk/referenceGuide/en/images/setup/inst_path.gif docs/trunk/referenceGuide/en/images/setup/inst_portal.gif docs/trunk/referenceGuide/en/images/setup/inst_secure.gif docs/trunk/referenceGuide/en/images/setup/package.gif docs/trunk/referenceGuide/en/images/setup/svncodir.gif Modified: docs/trunk/referenceGuide/en/modules/installation.xml docs/trunk/referenceGuide/en/modules/overview.xml docs/trunk/referenceGuide/en/modules/supported.xml Log: Updating the doc, installation guide and supported stuff Deleted: docs/trunk/referenceGuide/en/images/setup/build_deploy.gif =================================================================== (Binary files differ) Added: docs/trunk/referenceGuide/en/images/setup/build_deploy.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/setup/build_deploy.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: docs/trunk/referenceGuide/en/images/setup/build_ds.gif =================================================================== (Binary files differ) Added: docs/trunk/referenceGuide/en/images/setup/build_ds.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/setup/build_ds.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: docs/trunk/referenceGuide/en/images/setup/build_ds_dir.gif =================================================================== (Binary files differ) Added: docs/trunk/referenceGuide/en/images/setup/build_ds_dir.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/setup/build_ds_dir.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: docs/trunk/referenceGuide/en/images/setup/deploy_dir.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/dsfiles.gif =================================================================== (Binary files differ) Added: docs/trunk/referenceGuide/en/images/setup/dsfiles.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/setup/dsfiles.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: docs/trunk/referenceGuide/en/images/setup/inst_fin.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_lang.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_localhost.png =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_name.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_packs.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_path.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_portal.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_secure.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/package.gif =================================================================== (Binary files differ) Added: docs/trunk/referenceGuide/en/images/setup/package.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/setup/package.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: docs/trunk/referenceGuide/en/images/setup/svncodir.gif =================================================================== (Binary files differ) Added: docs/trunk/referenceGuide/en/images/setup/svncodir.png =================================================================== (Binary files differ) Property changes on: docs/trunk/referenceGuide/en/images/setup/svncodir.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: docs/trunk/referenceGuide/en/modules/installation.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/installation.xml 2007-09-07 11:11:16 UTC (rev 8196) +++ docs/trunk/referenceGuide/en/modules/installation.xml 2007-09-07 14:36:29 UTC (rev 8197) @@ -5,30 +5,19 @@ <note>Pre-configured clustered versions are available from the <ulink url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu... page</ulink> - , in the same 3 flavors as the non-clustered version. The installation difference, being that they must be + , in the same 3 flavors as the non-clustered version. The installation differences, being that they must be deployed in the <emphasis>all</emphasis> - configuration in JBoss AS. Read + configuration in JBoss AS and all your instances must reference the same datasource. Read <xref linkend="clustering"/> for more details on how to customize your clustered install, once deployed. </note> <note> - Binary distributions of JBoss Portal include the WSRP service which is not automatically deployed with the - source distribution. WSRP is built upon the JBoss WS web service stack. As such, it has some additional - constraints. In particular, there is a known issue with the version 1.0.0.GA of JBoss WS (bundled with JBoss - Application Server 4.0.4.GA) that prevents the complete deployment of JBoss Portal's WSRP service if the user - is not online or behind a firewall/proxy. This, in turn, prevents the deployment of JBoss Portal. If you do not - need the WSRP service, you can remove the - <filename>portal-wsrp.sar</filename> - file from the - <filename>jboss-portal.sar</filename> - file. If you'd like to use the WSRP service, the JBoss WS issue has been - addressed in version 1.0.2.GA of JBoss WS. Please follow the instructions on - <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=WSRP_UpdateJBossWS&quo... to upgrade JBoss WS</ulink> - as found on - <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossPortal">J... Portal's wiki</ulink> - . + <title>Installation of JBoss Portal on former version of JBoss AS</title> + <para>If you need to install JBoss Portal on JBoss AS 4.0.x, please refer to the dedicated + <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=Portal26_AS40">... page</ulink>.</para> </note> + </para> <sect1 id="install_bundle"> <title>Installing from Bundled Download</title> @@ -86,7 +75,8 @@ , documentation (which you are already reading), and a set of preconfigured datasource descriptors that allow JBoss Portal to communicate with a database. </para> - <para>This installation method is preferred by those who already have JBoss Application Server installed.</para> + <para>This installation method is preferred by those who already have JBoss Application Server installed or those we need to install + the version ready for clustering.</para> <sect2> <title>Setting up your environment</title> <sect3 id="install_binarydownload"> @@ -100,7 +90,7 @@ Once downloaded and extracted, the folder hierarchy should look like this: <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/package.gif"/> + <imagedata align="center" valign="middle" fileref="images/setup/package.png"/> </imageobject> </mediaobject> We will be using files contained in this download in the further sections, so please download and extract @@ -110,19 +100,15 @@ <sect3> <title>Application Server Setup</title> <para>Of course you will need to install JBoss Application Server prior to installing JBoss - portal, if you didn't do so yet, please install JBoss EAP 4.2, JBoss AS 4.2.1 or JBoss AS 4.0.5 if - you have to. You can have access to the EAP version from the support portal or the other versions + portal, if you didn't do so yet, please install JBoss EAP 4.2 or JBoss AS 4.2.1. If you have a + subscription contract with Red Hat, can have access to the EAP + version from the <ulink url="http://network.jboss.com/">support portal</ulink>. + For the other versions you can get them <ulink url="http://labs.jboss.com/portal/jbossas/download/index.html" </ulink> . - <warning>Make sure to download the JBoss AS Zip version. - <emphasis role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of JBoss - AS! - </emphasis> - We are currently working on aligning the Application installer with JBoss Portal. - </warning> </para> </sect3> <sect3> @@ -165,7 +151,7 @@ directory. <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/dsfiles.gif"/> + <imagedata align="center" valign="middle" fileref="images/setup/dsfiles.png"/> </imageobject> </mediaobject> </para> @@ -239,14 +225,14 @@ </listitem> <listitem> <para>From SVN, using the following URL: - <programlisting> - <![CDATA[http://anonsvn.jboss.org/repos/portal/trunk/]]> - </programlisting> + <itemizedlist> + <listitem>http://anonsvn.jboss.org/repos/portal/branches/JBoss_Portal_B... : For the latest sources of the 2.6 branch</listitem> + <listitem>http://anonsvn.jboss.org/repos/portal/trunk/ : For the latest sources</listitem> + </itemizedlist> <note> For more information on Portal SVN, and accessing different versions of the Portal codebase, please visit - <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... wiki article</ulink> - . + <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=PortalSVNRepo">... wiki article</ulink>. </note> </para> </listitem> @@ -256,35 +242,30 @@ After checking out of SVN or extracting the Source zip, your directory structure should look like this: <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/svncodir.gif"/> + <imagedata align="center" valign="middle" fileref="images/setup/svncodir.png"/> </imageobject> </mediaobject> <note> - The screenshot above, shows the downloaded source directory. Those of you checking out from SVN, will be - missing the - <emphasis>thirdparty</emphasis> - directory. This directory is created when you first run the build in the following steps. + <para>The screenshot above, shows the downloaded source directory. Those of you checking out from SVN, will get + an empty <emphasis>thirdparty</emphasis> directory. This directory will be filled when you first run the build + in the following steps.</para> </note> </para> </sect2> <sect2> - <title>Setting up your environment</title> + <title>Setting up the application server</title> <sect3> <title>Application Server Setup</title> <para>Of course you will need to install JBoss Application Server prior to installing JBoss - portal, if you didn't do so yet, please install JBoss EAP 4.2, JBoss AS 4.2.1 or JBoss AS 4.0.5 if - you have to. You can have access to the EAP version from the support portal or the other versions + portal, if you didn't do so yet, please install JBoss EAP 4.2 or JBoss AS 4.2.1. If you have a + subscription contract with Red Hat, can have access to the EAP + version from the <ulink url="http://network.jboss.com/">support portal</ulink>. + For the other versions you can get them <ulink url="http://labs.jboss.com/portal/jbossas/download/index.html" </ulink> . - <warning>Make sure to download the JBoss AS Zip version. - <emphasis role="bold">DO NOT ATTEMPT to deploy JBoss Portal on the installer version of JBoss - AS! - </emphasis> - We are currently working on aligning the Application installer with JBoss Portal. - </warning> </para> </sect3> <sect3 id="install_source_env"> @@ -314,6 +295,46 @@ <command>export JBOSS_HOME=/path/to/your/jboss/directory</command> </para> </sect3> + </sect2> + <sect2> + <title>Building/Deploying from Sources</title> + <para>To build and deploy the JBoss Portal service, go to + <filename>JBOSS_PORTAL_HOME_DIRECTORY/build</filename> + and type: + <programlisting>build deploy</programlisting> + <mediaobject> + <imageobject> + <imagedata align="center" valign="middle" fileref="images/setup/build_deploy.png"/> + </imageobject> + </mediaobject> + <note> + <para>During the first compilation, third-party libraries will be obtained from an online + repository, you need to be connected to Internet and if you are behind a proxy, you also + need to define your proxy address and host by adding: + <literal>JAVA_OPTS=-Dhttp.proxyHost=&lt;Proxy Host&gt; -Dhttp.proxyPort=&lt;Proxy Port&gt;</literal> in your environment. + </para> + </note> + <note>To build the clustered version, you will need to go to + <filename>JBOSS_PORTAL_HOME_DIRECTORY/build</filename> + and type: + <command>build main</command> + Then, go to + <filename>JBOSS_PORTAL_HOME_DIRECTORY/core</filename> + and type: + <command>build deploy-ha</command> + This will copy the + <filename>jboss-portal-ha.sar</filename> + to your + <filename>all</filename> + configuration for you. + </note> + At the end of the build process, the + <filename>jboss-portal.sar</filename> + is copied to <filename>JBOSS_HOME/server/default/deploy</filename>. + </para> + </sect2> + <sect2> + <title>Setting up the database</title> <sect3> <title>Database Setup</title> <para>You will need a database for JBoss Portal to function, you can use any database @@ -359,7 +380,7 @@ <programlisting>build datasource</programlisting> <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/build_ds.gif"/> + <imagedata align="center" valign="middle" fileref="images/setup/build_ds.png"/> </imageobject> </mediaobject> </para> @@ -367,7 +388,7 @@ Once complete, the datasource build should produce the following directory and file structure: <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/build_ds_dir.gif"/> + <imagedata align="center" valign="middle" fileref="images/setup/build_ds_dir.png"/> </imageobject> </mediaobject> </para> @@ -397,48 +418,10 @@ </sect3> </sect2> <sect2> - <title>Building/Deploying from Sources</title> - <para>To build and deploy the JBoss Portal service, go to - <filename>JBOSS_PORTAL_HOME_DIRECTORY/build</filename> - and type: - <programlisting>build deploy</programlisting> - <mediaobject> - <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/build_deploy.gif"/> - </imageobject> - </mediaobject> - <note>To build the clustered version, you will need to go to - <filename>JBOSS_PORTAL_HOME_DIRECTORY/build</filename> - and type: - <command>build main</command> - Then, go to - <filename>JBOSS_PORTAL_HOME_DIRECTORY/core</filename> - and type: - <command>build deploy-ha</command> - This will copy the - <filename>jboss-portal-ha.sar</filename> - to your - <filename>all</filename> - configuration for you. - </note> - At the end of the build process, the - <filename>jboss-portal.sar</filename> - is copied to - <filename>JBOSS_HOME/server/default/deploy</filename> - : - <mediaobject> - <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/deploy_dir.gif"/> - </imageobject> - </mediaobject> - Please verify that your - <filename>JBOSS_HOME/server/default/deploy</filename> - directory, contains both necessary files before starting JBoss Application Server. - </para> + <title>Starting and running JBoss Portal</title> <para> <emphasis role="bold">Start the Server:</emphasis> - Go to JBOSS_HOME/bin and execute run.bat (run.sh, if - Linux) + Go to JBOSS_HOME/bin and execute run.bat (run.sh, if Linux) <note>During the first boot (ever), SQL errors in the log, like the one below, can be safely ignored. They are thrown when the portal checks for the existence of the initial tables, before it creates them for you. @@ -574,7 +557,7 @@ <para> <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/inst_localhost.png"/> + <imagedata align="center" valign="middle" fileref="images/setup/default_ss.jpg"/> </imageobject> </mediaobject> </para> Modified: docs/trunk/referenceGuide/en/modules/overview.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/overview.xml 2007-09-07 11:11:16 UTC (rev 8196) +++ docs/trunk/referenceGuide/en/modules/overview.xml 2007-09-07 14:36:29 UTC (rev 8197) @@ -58,10 +58,6 @@ </ulink> | <ulink url="http://jboss.org/index.html?module=bb&amp;op=viewforum&... - | - <ulink url="http://jboss.org/index.html?module=bb&amp;op=viewforum&... Portlet - Plugin - </ulink> </para> </listitem> <listitem> Modified: docs/trunk/referenceGuide/en/modules/supported.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/supported.xml 2007-09-07 11:11:16 UTC (rev 8196) +++ docs/trunk/referenceGuide/en/modules/supported.xml 2007-09-07 14:36:29 UTC (rev 8197) @@ -26,6 +26,9 @@ <listitem>400 MHz CPU</listitem> </itemizedlist> </para> + <warning> + <para>JBoss Portal 2.6.2 is the last release to support JDK 1.4.</para> + </warning> </sect1> <sect1> <title>Supported Operating Systems</title> @@ -35,10 +38,13 @@ </sect1> <sect1> <title>JBoss Application Server</title> - <para>As of today JBoss Portal only works with JBoss Application Server.</para> - <para>JBoss AS 4.0.5.GA and JBoss AS 4.2.0.GA are supported.</para> + <para>JBoss Portal 2.6.2 is tested with JBoss AS 4.0.5, JBoss AS 4.2.1 and JBoss EAP 4.2. It is + highly recommended to use JBoss Portal 2.6.2 with JBoss Enterprise Application Platform 4.2 for + all who have access to it through the support portal and JBoss AS 4.2.1 for everybody else.</para> <warning> - <para> Versions before 4.0.4 of JBoss Application Server are not supported with this version of JBoss Portal.</para> + <para> Versions before 4.0.4 of JBoss Application Server are not supported with this version of JBoss Portal. + And JBoss AS 4.0.5 will not be supported in newer release of JBoss Portal. + </para> </warning> </sect1> <sect1 id="supportedversions-db">