Author: smumford Date: 2011-08-11 02:13:48 -0400 (Thu, 11 Aug 2011) New Revision: 7048 Modified: epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Book_Info.xml epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Installation.xml epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Revision_History.xml epp/docs/branches/5.1/Site_Publisher/Installation_Guide/publican.cfg Log: Updated for 5.1.1 Release. Modified: epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Book_Info.xml =================================================================== --- epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Book_Info.xml 2011-08-11 05:53:52 UTC (rev 7047) +++ epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Book_Info.xml 2011-08-11 06:13:48 UTC (rev 7048) @@ -9,7 +9,7 @@ <productname>JBoss Enterprise Portal Platform</productname> <productnumber>5.1</productnumber> <edition>2</edition> - <pubsnumber>5.1.2</pubsnumber> + <pubsnumber>5.1.3</pubsnumber> <abstract> <para> This book provides information about obtaining, installing and running the JBoss Enterprise Portal Platform Site Publisher extension. It forms the documentation suite along with the Site Publisher User Guide available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Site_Publisher/index.ht... /> Modified: epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Installation.xml =================================================================== --- epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Installation.xml 2011-08-11 05:53:52 UTC (rev 7047) +++ epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Installation.xml 2011-08-11 06:13:48 UTC (rev 7048) @@ -4,226 +4,226 @@ %BOOK_ENTITIES; ]> <chapter id="chap-Installation_Guide-Installation"> - <title>Installation</title> + <title>Installation</title> - <section id="sect-Installation_Guide-Installation-Pre_Installation_Requirements"> - <title><emphasis role="bold">Pre-Installation Requirements</emphasis></title> - <para> + <section id="sect-Installation_Guide-Installation-Pre_Installation_Requirements"> + <title><emphasis role="bold">Pre-Installation Requirements</emphasis></title> + <para> Site Publisher is an extension to the JBoss Enterprise Portal Platform product. It is not a standalone product. Therefore it needs to be installed into a working installation of JBoss Enterprise Portal Platform to function. - </para> - <para> - If you do not already have a installation of JBoss Enterprise Portal Platform you should follow the steps outlined in the JBoss Enterprise Portal Platform Installation Guide to obtain and install an instance of the Portal Platform. - </para> - <para> - The JBoss Enterprise Portal Platform Installation Guide is available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... />. A User Guide and Reference Guide are also available at this location and should be reviewed to ensure your Portal Platform is configured correctly. - </para> + </para> + <para> + If you do not already have a installation of JBoss Enterprise Portal Platform you should follow the steps outlined in the JBoss Enterprise Portal Platform Installation Guide to obtain and install an instance of the Portal Platform. + </para> + <para> + The JBoss Enterprise Portal Platform Installation Guide is available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... />. A User Guide and Reference Guide are also available at this location and should be reviewed to ensure your Portal Platform is configured correctly. + </para> <important> <title>JBoss Enterprise Portal Platform Environments</title> <para> - The <emphasis role="bold">Site Publisher</emphasis> add-on that is part of the &VZ; release can only be installed into a <emphasis>clean</emphasis> installation of JBoss Enterprise Portal Platform version 5.1 or later. - </para> - <itemizedlist> - <listitem> - <para> - It <emphasis role="bold">cannot</emphasis> be installed into a <emphasis>pre-existing</emphasis> and configured JBoss Enterprise Portal Platform installation (that is; a deployment that contains configuration settings or data that is not standard in the release). - </para> - </listitem> - <listitem> - <para> - Likewise, Site Publisher <emphasis role="bold">cannot</emphasis> be installed onto JBoss Enterprise Portal Platform 5.0 or 5.0.1 versions (including installations that include the technical preview release of the Site Publisher extension). - </para> - <para> - You must deploy a new instance of JBoss Enterprise Portal Platform 5.1.1 in order to use the Site Publisher add-on. - </para> - </listitem> - </itemizedlist> + The <emphasis role="bold">Site Publisher</emphasis> add-on that is part of the &VZ; release can only be installed into a <emphasis>clean</emphasis> installation of JBoss Enterprise Portal Platform version 5.1 or later. + </para> + <itemizedlist> + <listitem> + <para> + It <emphasis role="bold">cannot</emphasis> be installed into a <emphasis>pre-existing</emphasis> and configured JBoss Enterprise Portal Platform installation (that is; a deployment that contains configuration settings or data that is not standard in the release). + </para> + </listitem> + <listitem> + <para> + Likewise, Site Publisher <emphasis role="bold">cannot</emphasis> be installed onto JBoss Enterprise Portal Platform 5.0 or 5.0.1 versions (including installations that include the technical preview release of the Site Publisher extension). + </para> + <para> + You must deploy a new instance of JBoss Enterprise Portal Platform 5.1.1 in order to use the Site Publisher add-on. + </para> + </listitem> + </itemizedlist> </important> <note> - <title>JBoss Enterprise Portal Platform Subscriptions</title> - <para> + <title>JBoss Enterprise Portal Platform Subscriptions</title> + <para> Subscriptions for Site Publisher are separate from JBoss Enterprise Portal Platform subscriptions. - </para> - <para> + </para> + <para> If you do not already have a subscription to JBoss Enterprise Portal Platform you will need to obtain one in addition to your Site Publisher subscription in order to install and run Site Publisher. - </para> - </note> - </section> - - <section id="sect-Installation_Guide-Installation-Configuration_Locations"> - <title>Configuration Locations</title> - <para> - Installation of the Site Publisher add-on requires various configuration files to be copied to the configuration location of your JBoss Enterprise Portal Platform instance. - </para> - <para> - There are three possible locations for these configuration files depending on your JBoss Enterprise Portal Platform configuration setup: - </para> - <variablelist> - <varlistentry> - <term>Default</term> - <listitem> - <para> - <filename>jboss-epp-&VX;/jboss-as/server/default/deploy</filename>. - </para> + </para> + </note> + </section> + + <section id="sect-Installation_Guide-Installation-Configuration_Locations"> + <title>Configuration Locations</title> + <para> + Installation of the Site Publisher add-on requires various configuration files to be copied to the configuration location of your JBoss Enterprise Portal Platform instance. + </para> + <para> + There are three possible locations for these configuration files depending on your JBoss Enterprise Portal Platform configuration setup: + </para> + <variablelist> + <varlistentry> + <term>Default</term> + <listitem> + <para> + <filename>jboss-epp-<replaceable>&lt;version&gt;</replaceable>/jboss-as/server/default/deploy</filename>. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>All</term> - <listitem> - <para> - <filename>jboss-epp-&VX;/jboss-as/server/all/deploy</filename>. - </para> + </varlistentry> + <varlistentry> + <term>All</term> + <listitem> + <para> + <filename>jboss-epp-<replaceable>&lt;version&gt;</replaceable>/jboss-as/server/all/deploy</filename>. + </para> - </listitem> + </listitem> - </varlistentry> - <varlistentry> - <term>Production</term> - <listitem> - <para> - <filename>jboss-epp-&VX;/jboss-as/server/production/deploy</filename>. - </para> + </varlistentry> + <varlistentry> + <term>Production</term> + <listitem> + <para> + <filename>jboss-epp-<replaceable>&lt;version&gt;</replaceable>/jboss-as/server/production/deploy</filename>. + </para> - </listitem> + </listitem> - </varlistentry> + </varlistentry> - </variablelist> - <para> - Ensure you know which of the above configuration profiles are to be used in your JBoss Enterprise Portal Platform environment before you begin the installation. - </para> - <para> + </variablelist> + <para> + Ensure you know which of the above configuration profiles are to be used in your JBoss Enterprise Portal Platform environment before you begin the installation. + </para> + <para> Alternatively, the required files can be copied into each of the three locations to ensure that Site Publisher can be used with each of the three configuration profiles. - </para> - <para> - If you use a custom configuration profile, copy the files into the corresponding location of your profile. - </para> + </para> + <para> + If you use a custom configuration profile, copy the files into the corresponding location of your profile. + </para> - </section> - - <section id="sect-Installation_Guide-Installation-Installation_Instructions"> - <title>Installation Instructions</title> - <procedure> - <step> - <para> + </section> + + <section id="sect-Installation_Guide-Installation-Installation_Instructions"> + <title>Installation Instructions</title> + <procedure> + <step> + <para> If you have not already done so, deploy a new installation of JBoss Enterprise Portal Platform &VX;. - </para> + </para> - </step> - <step> - <para> - Download the <filename>jboss-eppsp-&VX;-exo-&lt;version&gt;-GA.zip</filename> file from the Red Hat JBoss Customer Support Portal and extract it to an easily accessible location. - </para> + </step> + <step> + <para> + Download the <filename>jboss-eppsp-<replaceable>&lt;version&gt;</replaceable>-exo-<replaceable>&lt;version&gt;</replaceable>-GA.zip</filename> file from the Red Hat JBoss Customer Support Portal and extract it to an easily accessible location. + </para> - </step> - <step> - <para> - Copy the <filename>gatein-wcm-extension-&lt;version&gt;-GA.ear</filename> file from the extracted location to the configuration location of your JBoss Enterprise Portal Platform installation (as discussed in <xref linkend="sect-Installation_Guide-Installation-Configuration_Locations" />). - </para> + </step> + <step> + <para> + Copy the <filename>gatein-wcm-extension-<replaceable>&lt;version&gt;</replaceable>-GA.ear</filename> file from the extracted location to the configuration location of your JBoss Enterprise Portal Platform installation (as discussed in <xref linkend="sect-Installation_Guide-Installation-Configuration_Locations" />). + </para> </step> - <step> - <para> - <emphasis role="bold">Optional step</emphasis>: - </para> - <para> - The extracted location will also contain the following files: + <step> + <para> + <emphasis role="bold">Optional step</emphasis>: + </para> + <para> + The extracted location will also contain the following files: </para> <itemizedlist> <listitem> <para> - <filename>gatein-eppspdemo-portal-&lt;version&gt;-GA.ear</filename> + <filename>gatein-eppspdemo-portal-<replaceable>&lt;version&gt;</replaceable>-GA.ear</filename> </para> </listitem> - <listitem> - <para> - <filename>gatein-ds.xml</filename> - </para> - </listitem> - <listitem> - <para> - <filename>wcm-ds.xml</filename> - </para> - </listitem> - </itemizedlist> + <listitem> + <para> + <filename>gatein-ds.xml</filename> + </para> + </listitem> + <listitem> + <para> + <filename>wcm-ds.xml</filename> + </para> + </listitem> + </itemizedlist> <para> These files provides a sample portal and are not required for the Site Publisher add-on to operate. - </para> + </para> <para> - Copying these files to the configuration location used in the previous step, however, will include a sample portal which can be used to verify a successful installation of the Site Publisher component. - </para> - <note> - <title>Overwriting gatein-ds.xml</title> - <para> - Be aware that a base installation of JBoss Enterprise Portal Platform already contains a <filename>gatein-ds.xml</filename> file in the <filename>deploy</filename> directory. It is recommended that this file be backed-up before copying the new Site Publisher version of the file. - </para> - <para> - This ensures that if you wish to 'uninstall' the Site Publisher add-on, you can revert to the original <filename>gatein-ds.xml</filename> file. - </para> - </note> - </step> - <step> - <para> - Start JBoss Enterprise Portal Platform using your established method, the procedures outlined in the JBoss Enterprise Portal Platform Installation Guide or by following the steps below: - </para> - <procedure> - <step> - <para> + Copying these files to the configuration location used in the previous step, however, will include a sample portal which can be used to verify a successful installation of the Site Publisher component. + </para> + <note> + <title>Overwriting gatein-ds.xml</title> + <para> + Be aware that a base installation of JBoss Enterprise Portal Platform already contains a <filename>gatein-ds.xml</filename> file in the <filename>deploy</filename> directory. It is recommended that this file be backed-up before copying the new Site Publisher version of the file. + </para> + <para> + This ensures that if you wish to 'uninstall' the Site Publisher add-on, you can revert to the original <filename>gatein-ds.xml</filename> file. + </para> + </note> + </step> + <step> + <para> + Start JBoss Enterprise Portal Platform using your established method, the procedures outlined in the JBoss Enterprise Portal Platform Installation Guide or by following the steps below: + </para> + <procedure> + <step> + <para> Open a command-line terminal session and navigate to the <filename>jboss-epp-&VX;/jboss-as/bin</filename> directory in the JBoss Enterprise Portal Platform location. - </para> + </para> - </step> - <step> - <para> - Run the command that corresponds to your operating environment. - </para> - <itemizedlist> - <listitem> - <para> - In Windows: - </para> - + </step> + <step> + <para> + Run the command that corresponds to your operating environment. + </para> + <itemizedlist> + <listitem> + <para> + In Windows: + </para> + <programlisting>run.bat</programlisting> - </listitem> - <listitem> - <para> - In Unix/Linux/Cygwin: - </para> - + </listitem> + <listitem> + <para> + In Unix/Linux/Cygwin: + </para> + <programlisting>./run.sh</programlisting> - </listitem> + </listitem> - </itemizedlist> + </itemizedlist> - </step> + </step> - </procedure> - </step> - <step> - <para> - If you included the <filename>gatein-ecmdemo-portal-&lt;version&gt;-GA.ear</filename> file from <emphasis role="bold">Step 5</emphasis>, navigate to <ulink type="http" url="http://localhost:8080/ecmdemo/public/classic">http://localhost:8080/ecmdemo/public/classic</ulink>. - </para> - <para> - If your installation has been successful, you will see the following sample homepage: - </para> - <mediaobject> - <imageobject role="html"> - <imagedata fileref="images/epp-sp-homepage.png" format="PNG" scale="90"/> - </imageobject> - <imageobject role="fo"> - <imagedata contentwidth="150mm" fileref="images/epp-sp-homepage.png" format="PNG" width="444" /> - </imageobject> + </procedure> + </step> + <step> + <para> + If you included the <filename>gatein-ecmdemo-portal-<replaceable>&lt;version&gt;</replaceable>-GA.ear</filename> file from <emphasis role="bold">Step 5</emphasis>, navigate to <ulink type="http" url="http://localhost:8080/ecmdemo/public/classic">http://localhost:8080/ecmdemo/public/classic</ulink>. + </para> + <para> + If your installation has been successful, you will see the following sample homepage: + </para> + <mediaobject> + <imageobject role="html"> + <imagedata fileref="images/epp-sp-homepage.png" format="PNG" scale="90"/> + </imageobject> + <imageobject role="fo"> + <imagedata contentwidth="150mm" fileref="images/epp-sp-homepage.png" format="PNG" width="444" /> + </imageobject> - </mediaobject> - <para> - If you did not include the <filename>gatein-ecmdemo-portal-&lt;version&gt;-GA.ear</filename> file, refer to the documentation available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... /> for instructions on how to create a portal using Site Publisher's features. - </para> + </mediaobject> + <para> + If you did not include the <filename>gatein-ecmdemo-portal-&lt;version&gt;-GA.ear</filename> file, refer to the documentation available at <ulink type="http" url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf... /> for instructions on how to create a portal using Site Publisher's features. + </para> - </step> + </step> - </procedure> + </procedure> <note> <title>JBoss Enterprise Portal Platform Installation</title> <para> @@ -234,7 +234,7 @@ </para> </note> - </section> + </section> </chapter> Modified: epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Revision_History.xml 2011-08-11 05:53:52 UTC (rev 7047) +++ epp/docs/branches/5.1/Site_Publisher/Installation_Guide/en-US/Revision_History.xml 2011-08-11 06:13:48 UTC (rev 7048) @@ -8,7 +8,7 @@ <simpara> <revhistory> <revision> - <revnumber>2-5.1.2</revnumber> + <revnumber>2-5.1.3</revnumber> <date>Fri Jul 15 2011</date> <author> <firstname>Scott</firstname> @@ -34,7 +34,7 @@ <member>Updated for 5.1.1 Release.</member> </simplelist> </revdescription> - </revision>--> + </revision> <revision> <revnumber>1-5.3</revnumber> <date>Wed June 22 2011</date> @@ -50,7 +50,7 @@ </simplelist> </revdescription> </revision> - <!-- <revision> + <revision> <revnumber>1-5.2</revnumber> <date>Thu Jun 02 2011</date> <author> Modified: epp/docs/branches/5.1/Site_Publisher/Installation_Guide/publican.cfg =================================================================== --- epp/docs/branches/5.1/Site_Publisher/Installation_Guide/publican.cfg 2011-08-11 05:53:52 UTC (rev 7047) +++ epp/docs/branches/5.1/Site_Publisher/Installation_Guide/publican.cfg 2011-08-11 06:13:48 UTC (rev 7048) @@ -4,7 +4,7 @@ xml_lang: en-US type: Book brand: JBoss -show_remarks: 1 +#show_remarks: 1 cvs_branch: DOCS-RHEL-6 cvs_root: :ext:cvs.devel.redhat.com:/cvs/dist cvs_pkg: JBoss_Enterprise_Portal_Platform-Site_Publisher_Installation_Guide-5.1-web-__LANG__