[jboss-cvs] JBoss Messaging SVN: r6698 - trunk/docs/quickstartguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu May 7 05:44:53 EDT 2009
Author: jmesnil
Date: 2009-05-07 05:44:52 -0400 (Thu, 07 May 2009)
New Revision: 6698
Modified:
trunk/docs/quickstartguide/en/modules/installation.xml
Log:
Quick start guide
* installation chapter
Modified: trunk/docs/quickstartguide/en/modules/installation.xml
===================================================================
--- trunk/docs/quickstartguide/en/modules/installation.xml 2009-05-07 09:13:18 UTC (rev 6697)
+++ trunk/docs/quickstartguide/en/modules/installation.xml 2009-05-07 09:44:52 UTC (rev 6698)
@@ -6,61 +6,92 @@
<section id="installation.prerequisites">
<title>Prerequisites</title>
- <para><note>JBoss Messaging only runs with Java 5 or later. We recommend Java 6 for the best performance.</note></para>
+ <para><note>JBoss Messaging only runs on Java 5 or later.</note></para>
<para>By default, JBoss Messaging server is run with 1GB of memory. If your computer has less memory,
modify the value in <literal>bin/run.sh</literal> accordingly.</para>
- <para><ulink url="http://ant.apache.org/">Ant</ulink> is required to build and run the examples.</para>
+ <para><ulink url="http://ant.apache.org/">Apache Ant</ulink> is required to create the profiles for JBoss AS 5 and run the examples.</para>
</section>
<section id="installation.standalone">
<title>Installing JBoss Messaging standalone</title>
- <para>After downloading the distribution unzip it into your chosen directory. At this point it should be possible
- to run straight out of the box, the following describes the directory structure that should be seen
+ <para>After downloading the distribution, unzip it into your chosen directory. At this point it should be possible
+ to run straight out of the box, the following describes the directory structure:
</para>
<programlisting>
|-- bin
|-- config
- |-- lib
+ | |-- jboss-as
+ | `-- stand-alone
|-- docs
| |-- api
+ | |-- quickstartguide
+ | |-- migrationguide
+ | |-- referenceguide
| `-- userguide
- `-- examples
+ |-- examples
+ | |-- javaee
+ | `-- jms
+ |-- lib
+ |-- licenses
+ `-- schemas
</programlisting>
<itemizedlist>
<listitem>
- <para>bin</para>
- <para>This contains the binaries and scripts needed to run JBM.</para>
+ <para><literal>bin</literal> -- binaries and scripts needed to run JBoss Messaging</para>
</listitem>
<listitem>
- <para>config</para>
- <para>This contains configuration files needed to configure JBM. Refer to the configuration chapter for
- details on how to do this.
+ <para><literal>config</literal> -- configuration files needed to configure JBoss Messaging. This contains configurations
+ to run JBoss Messaging either in standalone or inside JBoss AS 5. Please refer to the reference
+ guide for details on configuration.
</para>
</listitem>
<listitem>
- <para>lib</para>
- <para>This contains jars needed to run JBM.
+ <para><literal>docs</literal> -- guides and javadocs for JBoss Messaging
</para>
</listitem>
<listitem>
- <para>docs</para>
- <para>This contains this user guide and the JBM Javadocs..
+ <para><literal>examples</literal> -- JMS and Java EE examples. Please refer to the 'running examples'
+ chapter for details on how to run them.
</para>
</listitem>
<listitem>
- <para>examples</para>
- <para>This contains a set of examples. Refer to the 'running examples'
- chapter for details on how to run them.
+ <para><literal>lib</literal> -- jars and libraries needed to run JBoss Messaging
</para>
</listitem>
+ <listitem>
+ <para><literal>licenses</literal> -- licenses for JBoss Messaging
+ </para>
+ </listitem>
+ <listitem>
+ <para><literal>schemas</literal> -- XML Schemas used to validate JBoss Messaging configuration files</para>
+ </listitem>
</itemizedlist>
</section>
<section id="installation.jboss">
<title>Installing JBoss Messaging in JBoss AS 5</title>
- <para>At this point JBoss Messaging 2 Alpha is a technology preview and we only support the standalone or embedded
- versions.
- </para>
- </section>
+ <para>JBoss Messaging 2.0 can be deployed in <ulink url="http://www.jboss.org/jbossas/">JBoss AS 5</ulink>.
+ It is not shipped by default with the application server and you need to create new AS 5 profiles to run AS 5 with JBoss Messaging.</para>
+ <para>To create AS 5 profiles:</para>
+ <orderedlist>
+ <listitem><para>Download JBoss AS 5</para></listitem>
+ <listitem><para>Set the environment property <literal>JBOSS_HOME</literal> to point to the directory where you installed JBoss AS 5</para></listitem>
+ <listitem><para>run <literal>ant</literal> in JBoss Messaging's <literal>config/jboss-as</literal> directory</para></listitem>
+ </orderedlist>
+
+ <para>This will create 2 new profiles in <literal>$JBOSS_HOME/server</literal>:</para>
+ <itemizedlist>
+ <listitem><para><literal>default-with-jbm2</literal> -- it corresponds to AS 5 <literal>default</literal>
+ profile with JBoss Messaging 2 as its JMS provider. In this profile, JBoss Messaging is <emphasis>non-clustered</emphasis></para></listitem>
+ <listitem><para><literal>all-with-jbm2</literal> -- it corresponds to AS 5 <literal>all</literal>
+ profile with JBoss Messaging 2 as its JMS provider. In this profile, JBoss Messaging is <emphasis>clustered</emphasis></para></listitem>
+ </itemizedlist>
+
+ <para>You can then start JBoss AS 5 using one of these profiles:</para>
+ <programlisting>$JBOSS_HOME/bin/run.sh -c default-with-jbm2</programlisting>
+
+ </section>
+
+
</chapter>
\ No newline at end of file
More information about the jboss-cvs-commits
mailing list