Author: smumford Date: 2010-11-30 02:18:16 -0500 (Tue, 30 Nov 2010) New Revision: 5374 Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/ClusteringConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/DatabaseConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/EMailServiceConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Getting_Started.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/HTTPSConfiguration.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Installation.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Launching.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Post_Installation.xml epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Test_Your_Installation.xml Log: Homogenized file paths with other EPP docs Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/ClusteringConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/ClusteringConfiguration.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/ClusteringConfiguration.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -44,7 +44,7 @@ <section id="sect-Reference_Guide-Clustering_Properties"> <title>configuration.properties</title> - <para>Edit the following entries in the <filename>$JBOSS_HOME/jboss-as/server/$CONFIG/conf/gatein/configuration.properties</filename> file:</para> + <para>Edit the following entries in the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/configuration.properties</filename> file:</para> <itemizedlist> <listitem> <para> Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/DatabaseConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/DatabaseConfiguration.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/DatabaseConfiguration.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -39,7 +39,7 @@ <para>To configure the database datasource used by JCR you will need to edit the datasource descriptor located at - <filename>$JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml</filename>: + <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>: <programlisting> &lt;no-tx-datasource&gt; &lt;jndi-name&gt;gatein-jcr&lt;/jndi-name&gt; @@ -70,7 +70,7 @@ created.</para> <para>Add the JDBC driver to the classpath, by copying the relevant - JAR file to the <filename>$JBOSS_HOME/server/$CONFIG/lib</filename> directory.</para> + JAR file to the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/lib</filename> directory.</para> </section> @@ -79,7 +79,7 @@ <title>Configuring the database datasource for the default identity store</title> <para>To configure the database datasource used by IDM you will need to edit the - datasource descriptor located at <filename>$JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml</filename>: + datasource descriptor located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>: <programlisting> &lt;no-tx-datasource&gt; @@ -239,7 +239,7 @@ <orderedlist> <listitem> <para> - Edit the file located at <filename>$JBOSS_HOME/server/$CONFIG/deploy/gatein-ds.xml</filename>. + Edit the file located at <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein-ds.xml</filename>. </para> </listitem> <listitem> Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/EMailServiceConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/EMailServiceConfiguration.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/EMailServiceConfiguration.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -20,11 +20,11 @@ <title>Configuring the outgoing e-mail account</title> <para>The e-mail service can use any SMTP account configured in - <filename>$JBOSS_HOME/server/$CONFIG/conf/gatein/configuration.properties</filename></para> + <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/configuration.properties</filename></para> <para>The relevant section looks like:</para> - <programlisting># EMail +<programlisting># EMail gatein.email.smtp.username= gatein.email.smtp.password= gatein.email.smtp.host=smtp.gmail.com Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Getting_Started.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Getting_Started.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Getting_Started.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -697,7 +697,7 @@ For security reasons, before going in production, you should restrict the access to the login servlet to POST. </para> <para> - To do so, edit the file <filename>$JBOSS_HOME/server/[configuration]/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: + To do so, edit the file <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: </para> <programlisting language="XML" role="XML"><![CDATA[ <security-constraint> Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/HTTPSConfiguration.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/HTTPSConfiguration.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/HTTPSConfiguration.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -48,7 +48,7 @@ <title><emphasis role="bold"></emphasis></title> <step> <para> - Comment the following lines in <filename>jboss/server/<replaceable>PROFILE</replaceable>/deploy/jbossweb.sar/server.xml</filename>: + Comment the following lines in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jbossweb.sar/server.xml</filename>: </para> <programlisting><![CDATA[<Connector protocol="HTTP/1.1" port="8080" address="${jboss.bind.address}" connectionTimeout="20000" redirectPort="8443" > Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Installation.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Installation.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Installation.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -69,7 +69,7 @@ </listitem> <listitem> <para> - the <literal>production</literal> server configuration includes Portal components and clustering services. It is preconfigured with default settings which would be more accurate for a production environment. + the <literal>production</literal> server configuration includes Portal components and clustering services. It is preconfigured with default settings which would be more accurate for a production environment. </para> </listitem> </itemizedlist> Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Launching.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Launching.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Launching.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -18,7 +18,7 @@ </step> <step> <para> - Within this directory navigate to <filename>/jboss-as/bin</filename>. + Within this directory navigate to <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin</filename>. </para> </step> <step> @@ -62,7 +62,7 @@ <procedure> <step> <para> - Navigate to the <filename>/jboss-as/bin</filename> directory as discussed in <xref linkend="sect-Install_Guide-Launching_PRODUCT-Launching_a_Zip_installation" />. + Navigate to the <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin</filename> directory as discussed in <xref linkend="sect-Install_Guide-Launching_PRODUCT-Launching_a_Zip_installation" />. </para> </step> <step> Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Post_Installation.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Post_Installation.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Post_Installation.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -14,7 +14,7 @@ On a Linux Platform </title> <para> - Create an environment variable that points to the installation directory (<filename>JBOSS_DIST/jboss-as</filename>) and call it <literal>JBOSS_HOME</literal>. Add <literal>$JBOSS_HOME/bin</literal> to the system path to be able to run the server from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your home directory. + Create an environment variable that points to the installation directory (<filename><replaceable>&lt;JBOSS_DIST&gt;</replaceable>/jboss-as</filename>) and call it <literal>JBOSS_HOME</literal>. Add <literal>$JBOSS_HOME/bin</literal> to the system path to be able to run the server from the command line. You can do this by adding the following lines to the <filename>.bashrc</filename> file in your home directory. </para> </formalpara> <programlisting> @@ -51,7 +51,7 @@ <para><remark>End Note to Reviewer</remark></para> --> <para> - If the server is running out of memory, you may adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename>JBOSS_DIST/jboss-as/bin/run.conf</filename> on Linux or <filename>JBOSS_DIST/jboss-as/bin/run.conf.bat</filename> on Windows. The default values don't take into account the memory requirements of your applications: + If the server is running out of memory, you may adjust the memory settings before deploying the applications. You can do this by updating <literal>JAVA_OPTS</literal> settings in the file <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin/run.conf</filename> on Linux or <filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin/run.conf.bat</filename> on Windows. The default values don't take into account the memory requirements of your applications: <programlisting> -Xms1303m -Xmx1303m -XX:MaxPermSize=256m .... </programlisting> @@ -73,33 +73,34 @@ It is recommended that the admin=admin username and password configuration, which is commented out by default, not be used for a production server. The admin user is included as an example of the username/password definition format only. </para> </important> - + <note> + <title><replaceable>JBOSS_HOME</replaceable> and <replaceable>&lt;PROFILE&gt;</replaceable></title> + <para> + <replaceable>JBOSS_HOME</replaceable> is the <filename>jboss-as</filename> directory, a level above the bin directory. <replaceable>&lt;PROFILE&gt;</replaceable> is the chosen server profile: all, default, minimal production, standard or web. + </para> + </note> <formalpara><title>Set up the <literal>jmx-console</literal> users and roles</title> <para> - Edit the <filename>jmx-console-users.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/conf/props/</filename> directory defining the username and password: + Edit the <filename>jmx-console-users.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/props/</filename> directory defining the username and password: </para> </formalpara> <programlisting>user=password</programlisting> <para> - Edit the <filename>jmx-console-roles.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/conf/props/</filename> directory to define the user's roles: + Edit the <filename>jmx-console-roles.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/props/</filename> directory to define the user's roles: </para> <programlisting>user=JBossAdmin,HttpInvoker</programlisting> <formalpara><title>Set up the <literal>admin-console</literal> users and roles</title> <para> - Edit the <filename>web-console-users.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: + Edit the <filename>web-console-users.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: </para> </formalpara> <programlisting>user=password</programlisting> <para> - Edit the <filename>web-console-roles.properties</filename> file located in the <filename>$JBOSS_HOME/server/$CONFIG/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: + Edit the <filename>web-console-roles.properties</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/classes/</filename> directory: </para> <programlisting>user=JBossAdmin,HttpInvoker</programlisting> - <note><title>$JBOSS_HOME and $CONFIG</title> - <para> - <varname>$JBOSS_HOME</varname> is the <filename>jboss-as</filename> directory, a level above the bin directory. <varname>$CONFIG</varname> is the chosen server configuration - all, default, minimal production, standard or web. - </para> - </note> + <important> <para> Login credentials for the <literal>admin-console</literal> are the same as those used for the JMX console. @@ -108,11 +109,13 @@ <formalpara> <title>Set SuckerPassword for JBoss Messaging:</title> <para> - JBoss Messaging makes internal connections between nodes in order to redistribute messages between clustered destinations. These connections are made with the user name of a special reserved user whose password is specified by the <literal>suckerPassword</literal> attribute in the Server Peer configuration file: - <programlisting>$JBOSS_HOME/server/$CONFIG/deploy/messaging/messaging-jboss-beans.xml</programlisting> - Where <literal>$JBOSS_HOME</literal> is the install directory and <literal>$CONFIG</literal> is the server configuration being used. - To avoid a security risk, you MUST specify the value of the <literal>SuckerPassword</literal> attribute, failing which the default value will be used. Any one who knows the default password will be able to gain access to any destinations on the server. The following fragment should be uncommented and modified: - <programlisting>&lt;bean name="SecurityStore" + JBoss Messaging makes internal connections between nodes in order to redistribute messages between clustered destinations. These connections are made with the user name of a special reserved user whose password is specified by the <literal>suckerPassword</literal> attribute in the Server Peer configuration file: <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/messaging/messaging-jboss-beans.xml</filename>. + </para> + </formalpara> + <para> + To avoid a security risk, you MUST specify the value of the <literal>SuckerPassword</literal> attribute, failing which the default value will be used. Any one who knows the default password will be able to gain access to any destinations on the server. The following fragment should be uncommented and modified: + </para> +<programlisting>&lt;bean name="SecurityStore" class="org.jboss.jms.server.jbosssx.JBossASSecurityMetadataStore"&gt; &lt;!­­ default security configuration ­­­&gt; ­... @@ -124,8 +127,7 @@ ­... &lt;/bean&gt; </programlisting> - </para> - </formalpara> + </section> <section id="Disabling_Authentication"> @@ -134,23 +136,14 @@ <para> It is possible to disable authentication for specific services by following the instructions in this section. </para> - <para> - All paths specified in the sub-sections below are relative to <literal>$JBOSS_HOME</literal>. - </para> + <formalpara> <title>Disabling Authentication for JXM Console:</title> <para> - To disable authentication for the JMX console, edit the following file and comment out the security-constraint section: + To disable authentication for the JMX console, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/jmx-console.war/WEB-INF/web.xml</filename> file and comment out the security-constraint section: </para> </formalpara> - <programlisting> -server/$CONFIG/deploy/jmx-console.war/WEB-INF/web.xml -</programlisting> - <para> - The following fragment should be commented out: - </para> -<programlisting> &lt;security-constraint&gt; &lt;web-resource-collection&gt; &lt;web-resource-name&gt;HtmlAdaptor&lt;/web-resource-name&gt; @@ -170,12 +163,8 @@ <formalpara> <title>Disabling Authentication for Web Console:</title> <para> - To disable authentication for the Web console, edit the following file to comment out the security-constraint section: - <programlisting> -server/$CONFIG/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml - </programlisting> - The following fragment should be commented out: - <programlisting> + To disable authentication for the Web console, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml</filename> file to comment out the security-constraint section: +<programlisting> &lt;security-constraint&gt; &lt;web-resource-collection&gt; &lt;web-resource-name&gt;HtmlAdaptor&lt;/web-resource-name&gt; @@ -196,12 +185,8 @@ <formalpara> <title>Disabling Authentication for HTTP Invoker:</title> <para> - To disable authentication for the http invoker, <literal>JNDIFactory</literal>, <literal>EJBInvokerServlet</literal>, and <literal>JMXInvokerServlet</literal> need to be removed from the security realm in the file: - <programlisting> -server/$CONFIG/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml - </programlisting> - For example, the security-constraint element should look as follows: - <programlisting> + To disable authentication for the http invoker, <literal>JNDIFactory</literal>, <literal>EJBInvokerServlet</literal>, and <literal>JMXInvokerServlet</literal> need to be removed from the security realm in the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml</filename> file: +<programlisting> &lt;security-constraint&gt; &lt;web-resource-collection&gt; &lt;web-resource-name&gt;HttpInvokers&lt;/web-resource-name&gt; @@ -222,12 +207,13 @@ <formalpara> <title>Disabling Authentication for JMX Invoker:</title> <para> - To disable authentication for the JMX invoker, edit the following file to comment out the security interceptor passthrough: - <programlisting> -server/$CONFIG/deploy/jmx-invoker-service.xml - </programlisting> - Locate the mbean section with the class <literal>org.jboss.jmx.connector.invoker.InvokerAdaptorService</literal>. In that section comment out the line that relates to authenticated users: - <programlisting> + To disable authentication for the JMX invoker, edit the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/management/console-mgr.sar/web-console.war/WEB-INF/web.xml/deploy/httpha-invoker.sar/invoker.war/WEB-INF/web.xml/deploy/jmx-invoker-service.xml</filename> file to comment out the security interceptor passthrough: + </para> + </formalpara> + <para> + Locate the mbean section with the class <literal>org.jboss.jmx.connector.invoker.InvokerAdaptorService</literal>. In that section comment out the line that relates to authenticated users: + </para> +<programlisting> &lt;descriptors&gt; &lt;interceptors&gt; &lt;!-- Uncomment to require authenticated users --&gt; @@ -238,9 +224,8 @@ policyClass="StripModelMBeanInfoPolicy"/&gt; &lt;/interceptors&gt; &lt;/descriptors&gt; - </programlisting> - </para> - </formalpara> +</programlisting> + <formalpara> <title>Disabling Pre-configured Accounts</title> <para> @@ -251,7 +236,7 @@ For security reasons, before going in production, you should restrict the access to the login servlet to POST. </para> <para> - To do so, edit the file <filename>$JBOSS_HOME/server/[configuration]/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: + To do so, edit the file <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/gatein.ear/02portal.war/WEB-INF/web.xml</filename> and add: </para> <programlisting language="XML" role="XML"><![CDATA[ <security-constraint> Modified: epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Test_Your_Installation.xml =================================================================== --- epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Test_Your_Installation.xml 2010-11-30 06:09:59 UTC (rev 5373) +++ epp/docs/branches/EPP_5_1_Branch/Installation_Guide/en-US/Test_Your_Installation.xml 2010-11-30 07:18:16 UTC (rev 5374) @@ -15,7 +15,7 @@ <itemizedlist> <listitem> <para> - move to the <filename>$JBOSS_HOME/bin</filename> directory; + move to the <filename><replaceable>JBOSS_HOME</replaceable>/bin</filename> directory; </para> </listitem> <listitem> @@ -24,7 +24,7 @@ <itemizedlist> <listitem> <para> - Ensure that you run the configuration corresponding to the <filename>$JBOSS_HOME/server/$CONFIG/</filename> chosen in <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"></xref> + Ensure that you run the configuration corresponding to the <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/</filename> chosen in <xref linkend="form-Portal_EAP-Using_a_MySQL_Database-Creating_a_MySQL_Database"></xref> </para> </listitem> </itemizedlist> @@ -33,7 +33,7 @@ </itemizedlist> </para> <para> - The example below uses the production configuration. Your output should look like the following (accounting for installation directory differences) and should not contain any error or exception messages: + The example below uses the production configuration. Your output should look like the following (accounting for installation directory differences and version numbers) and should not contain any error or exception messages: </para> <programlisting> [user@localhost bin]$ ./run.sh -c production @@ -70,7 +70,7 @@ </programlisting> <note><title>Note: Production server log file</title> <para> - There is no "Server Started" message shown at the console when the server is started using the <literal>production</literal> profile. This message may be observed in the <filename>server.log</filename> file located in the <filename>server/production/log</filename> subdirectory. + There is no "Server Started" message shown at the console when the server is started using the <literal>production</literal> profile. This message may be observed in the <filename>server.log</filename> file located in the <filename><replaceable>JBOSS_HOME</replaceable>/server/production/log</filename> subdirectory. </para> </note>