[jboss-cvs] jboss-docs/jbossas/install/en ...
Norman Richards
norman.richards at jboss.com
Wed Oct 18 00:56:39 EDT 2006
User: nrichards
Date: 06/10/18 00:56:39
Modified: jbossas/install/en master.xml
Log:
jems installer updates
Revision Changes Path
1.4 +113 -136 jboss-docs/jbossas/install/en/master.xml
(In the diff below, changes in quantity of whitespace are not shown.)
Index: master.xml
===================================================================
RCS file: /cvsroot/jboss/jboss-docs/jbossas/install/en/master.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- master.xml 16 Oct 2006 17:21:58 -0000 1.3
+++ master.xml 18 Oct 2006 04:56:39 -0000 1.4
@@ -19,14 +19,14 @@
<preface>
<title>About this Guide</title>
- <para>JBoss AS is an open source J2EE 1.4 certified application server. It is the most widely used application
- server on the market. The highly flexible and easy-to-use server architecture has made JBoss AS the ideal
- choice for users just starting out with J2EE, as well as senior architects looking for a customizable
- middleware platform. The ready availability of the source code allows you to debug the server, learn its
- inner workings and create customized versions for your personal or business use. This guide will show you
- how to download and install JBoss AS 4.0. You will learn how to start and stop your JBoss instance, and you
- will also learn about the directory structure and understand what the key services and configuration files
- are. </para>
+ <para>JBoss AS is a J2EE 1.4-certified, open source Java application server. It is the most widely used
+ application server on the market. The highly flexible and easy-to-use server architecture has made JBoss AS
+ the ideal choice for users just starting out with J2EE, as well as senior architects looking for a
+ customizable middleware platform. The ready availability of the source code allows you to debug the server,
+ learn its inner workings and create customized versions for your personal or business use. This guide will
+ show you how to install JBoss AS 4.0. You will learn how to start and stop your JBoss instance, and you will
+ also learn about the directory structure and understand what the key services and configuration files are.
+ </para>
</preface>
@@ -34,12 +34,12 @@
<title>Installing JBoss</title>
<para> Before installing the server, you need to check your system to make sure you have a suitable Java
- installation. JBoss 4 requires either a Java 1.4 or Java 5 JVM (Java Virtual Machine) to run. Java 5 is
- required to use the newer simplified EJB3 technologies. The choice of JVMs is yours otherwise, but we do
- recommend considering the Java 5 JVM where possible to take advantage of the latest JVM performanace
- improvements and monitoring capabilities. No matter what JVM is chosen, you should generally prefer the
- latest stable versions and keep an eye on future bug fix releases for issues that might affect your
- installation. </para>
+ installation. JBoss 4 requires either a Java 1.4 or Java 5 (sometimes referred to as Java 1.5) JVM (Java
+ Virtual Machine) to run. Java 5 is only required to use the newer simplified EJB3 technologies. The choice
+ of JVMs is yours otherwise, but we do recommend considering the Java 5 JVM where possible to take advantage
+ of the latest JVM performance improvements and monitoring capabilities. No matter what JVM is chosen, you
+ should generally prefer the latest stable versions and keep an eye on future bug fix releases for issues
+ that might affect your installation. </para>
<para>To verify your Java environment execute the <literal>java -version</literal> command. This will ensure
that the <literal>java</literal> executable is in your path and that you are using the intended Java
@@ -47,13 +47,13 @@
appropriate version, check your JVM installation instructions.</para>
- <programlisting>[tmp]$ java -version
+ <programlisting>$ java -version
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_02-56)
Java HotSpot(TM) Client VM (build 1.5.0_02-36, mixed mode, sharing)</programlisting>
<para>JBoss AS is distributed as part of the Red Hat JBoss Media Kit. Recent JBoss releases are also available
(both in binary and source form) online from the JBoss AS downloads page, <ulink
- url="http://labs.jboss.org/portal/jbossas/download/"/> and as part of the JEMS distribution, available
+ url="http://labs.jboss.org/portal/jbossas/download/"/>, and as part of the JEMS distribution, available
online at <ulink url="http://labs.jboss.com/portal/jemsinstaller/downloads"/>. </para>
@@ -62,15 +62,15 @@
extract the archive. The gzipped tar file requires a gnutar-compatible tar program that can handle the long
pathnames in the archive. The default tar binaries on Solaris and OS X do not currently support the long
pathnames. </para>
- <para> The standard JBoss 4.0.4 ZIP distribution will be named <literal>jboss-4.0.4.GA.zip</literal>. If service
- pack releases may later become available, they will contain the <literal>SP</literal> designation,
- <literal>jboss-4.0.4SP1.zip</literal> for example. You can use use the JDK <literal>jar</literal> tool
- (or any other ZIP extraction tool) to extract the archive contents into a directory of your choice. It does
- not matter where on your system you install JBoss. Note, however, that installing JBoss into a directory
- that has a name that contains spaces causes problems on some platforms with Sun-based VMs. </para>
+ <para> The standard JBoss 4.0.4 ZIP distribution is named <literal>jboss-4.0.4.GA.zip</literal>. If service pack
+ releases later become available, they will contain the <literal>SP</literal> designation,
+ <literal>jboss-4.0.4SP1.zip</literal> for example. You can use the JDK <literal>jar</literal> tool (or
+ any other ZIP extraction tool) to extract the archive contents into a directory of your choice. It does not
+ matter where on your system you install JBoss. Note, however, that installing JBoss into a directory that
+ has a name that contains spaces causes problems on some platforms with Sun-based VMs. </para>
- <para>The resulting JBoss installation is a raw installation containing all the JBoss AS services in a
+ <para>The resulting JBoss installation is a raw installation containing the entire set of JBoss AS services in a
completely unconfigured state. It is the quickest way to get a runnable JBoss instance, but the latter work
to configure the server can be quite intensive. JBoss now provides a GUI installer that can simplify the
installation process. In addition to the basic installation, the installer allows you to select the which
@@ -87,7 +87,7 @@
system doesn't support that, you can run the installer directly from the command line: (The remainder of
this guide will assume the JEMS 1.2.0 installer, available from <ulink
url="http://labs.jboss.com/portal/jemsinstaller/downloads"/>) </para>
- <programlisting>[tmp]$ java -jar jems-installer-1.2.0.jar</programlisting>
+ <programlisting>$ java -jar jems-installer-1.2.0.jar</programlisting>
@@ -144,11 +144,11 @@
</figure>
- <para> The installer will ask you for the directory you want to install JBoss into. This is shown in <xref
+ <para> The installer will ask for the directory to use for the installation. This is shown in <xref
linkend="install_dir_select"/>. The installer does not write the installation directory into any of the
- scripts or into any form of registery, so you will be free to move or rename the JBoss installation
- directory after installation. On some platforms, installation directories that contains spaces can cause
- problems, so we recommend sticking to simple directory names. </para>
+ scripts or into any form of registry, so you will be free to move or rename the JBoss installation directory
+ after installation. On some platforms, installation directories that contains spaces can cause problems, so
+ we recommend sticking to simple directory names. </para>
<figure id="install_dir_select">
<title>Selecting the installation directory</title>
@@ -269,11 +269,11 @@
<para> After selecting the configuration set, you have the option to further customize the installation,
customizing the set of services installed. <xref linkend="install_package_select"/> shows the package
selection screen. The installer knows the dependencies between services and will not allow you to configure
- services in an incompatible way. This is much easier than the trial and error approach of configuring
+ services in an incompatible way. This is much safer than the trial and error approach of configuring
services by hand from a raw ZIP install. When choosing configuration sets, be aware that you can not add
- packages that are not a part of the selected configuration set. If you you wanted a simple web container
- (the tomcat configuration) that also had JMS support (the jms configuration), it would be necessary to go to
- a larger configuration, such as the default configuration, and remove the unwanted packages. There are some
+ packages that are not a part of the selected configuration set. If you wanted a simple web container (the
+ tomcat configuration) that also had JMS support (the jms configuration), it would be necessary to go to a
+ larger configuration, such as the default configuration, and remove the unwanted packages. There are some
combinations of JEMS components that are not supported directly through the installer. </para>
<figure id="install_package_select">
@@ -305,8 +305,8 @@
- <para> Almost all applications require a datasource to connect to a backend database. JBoss provides an embedded
- Hypersonic database along with a default datasource to connect applications to. Being able to run
+ <para> Almost all applications require a datasource to connect to a back-end database. JBoss provides an
+ embedded Hypersonic database along with a default datasource to connect applications to. Being able to run
applications out of the box makes JBoss very developer friendly. All projects will eventually need to move
to a more capable database, but most will choose to do so at the very beginning of the project. The
datasource configuration screen, shown in <xref linkend="install_datasource"/>, gives you the option to use
@@ -337,8 +337,8 @@
</figure>
<para> Note that when installing a datasource this way, you must place the correct JDBC driver JAR file the lib
- directory of your server configuration. See <xref linkend="dirs"/> for more information about JBoss
- directory structure. </para>
+ directory of your server configuration. The datasource will not be usable until this is done. See <xref
+ linkend="dirs"/> for more information about JBoss directory structure, including the lib directory. </para>
<para>The next screen allows you to enable applications isolation, completely separating the classloading space
of all applications. Application isolation can be helpful in some instances, but it comes with the cost of
@@ -361,8 +361,8 @@
<para> When installed from a raw archive, all JBoss services are left in a developer-friendly state requiring no
authentication to access most JBoss services, including administrative services. The installer gives you a
chance to secure those services on the security screen, shown in <xref linkend="install_security"/>. It is
- recommended that you click to enable security for all services. You will be required to enter a password for
- the admin user. We strongly recommend not using the default password, "admin". </para>
+ recommended that you enable security for all services. You will be required to enter a password for the
+ admin user. We strongly recommend not using the default password, "admin". </para>
@@ -420,33 +420,34 @@
<chapter id="automated_install">
<title>Command-line installation</title>
- <para> The GUI installer obviously requires a display to run. but many servers run in headless mode with no
- graphical display options. In these cases, the installer can be run on a machine with a display, and the
+ <para> Running the GUI installer requires a graphical display to run. but many servers run in headless mode with
+ no graphical display options. In these cases, the installer can be run on a machine with a display, and the
resulting JBoss installation can be copied to the server machine. Another option for installing in these
- environments is to use the commandline installation capabilities. The JBoss installer can be run from the
- commandline installing either a base server profile or recreating a previous installation using the
+ environments is to use the command-line installation capabilities. The JBoss installer can be run from the
+ command-line installing either a base server profile or recreating a previous installation using the
installer script created during a previous installation. </para>
<para>When you want to install a specific configuration set, the installer can be run from the command line
using the -installGroup and installpath options: </para>
- <programlisting>java -jar jems-installer-1.2.0.BETA2.jar -installGroup default installpath=/opt/jboss-4.0.4</programlisting>
+ <programlisting>$ java -jar jems-installer-1.2.0.jar -installGroup default installpath=/opt/jboss-4.0.4</programlisting>
- <para>The -installGroup parameter is any valid installation group. Different JBoss installers install have
- different options. The options for the JEMS 1.2 installer are shown in <xref linkend="installgroup.table"/>.
- The installpath options specifies the directory you want to install JBoss into. If you do not specify the
- installpath option, the installer defaults to a directory named jboss-install. </para>
-
- <para> This type of installation provides no ability to specify specific specific packages or to use the
- security and datasource configuration options. These options can be set when using an installer script.
- Script generation requires running the actual GUI interface, but the generated script can be used from the
- commandline. The last panel of the installer provides the option to save an installer script that preserves
- all of the selections made in the installer. The installation can be run by passing the installation script
- as a parameter to the installer. </para>
+ <para>The -installGroup parameter is any valid installation group for the installer being used. Different JBoss
+ installers install have different options. The options for the JEMS 1.2 installer are shown in <xref
+ linkend="installgroup.table"/>. The installpath options specifies the directory you want to install
+ JBoss into. If you do not specify the installpath option, the installer defaults to a directory named
+ jboss-install. </para>
+
+ <para> This type of installation provides no ability to specify specific packages or to use the security and
+ datasource configuration options. These options can be set when using an installer script. Script generation
+ requires running the actual GUI interface, but the generated script can be used from the command-line . The
+ last panel of the installer provides the option to save an installer script that preserves all of the
+ selections made in the installer. The installation can be run by passing the installation script as a
+ parameter to the installer. </para>
- <programlisting>java -jar jems-installer-1.2.0.BETA2.jar installscript.xml</programlisting>
+ <programlisting>$ java -jar jems-installer-1.2.0.jar installscript.xml</programlisting>
- <para> The installation script is a simple XML file that can be safely editted if further customization is
+ <para> The installation script is a simple XML file that can be safely edited if further customization is
needed. The most likely detail to change would be the installation directory. </para>
@@ -459,7 +460,7 @@
distribution layout to locate JARs for compiling code, updating configurations, deploying your code, etc.
<xref linkend="ch1.dirs.fig"/> illustrates the installation directory of the JBoss server.</para>
<figure id="ch1.dirs.fig">
- <title>The JBoss AS directroy structure</title>
+ <title>The JBoss AS directory structure</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/jboss_directory_structure.jpg"/>
@@ -476,7 +477,7 @@
<literal>org.jboss.system.server.ServerConfig</literal> interface constant and its corresponding system
property string are shown. The names ending in <literal>URL</literal> correspond to locations that can be
specified using a URL to access remote locations, for example, HTTP URLs against a web server. <xref
- linkend="ch1.dirs.table"/> shows the the top-level directories and their function. </para>
+ linkend="ch1.dirs.table"/> shows the top-level directories and their function. </para>
<table id="ch1.dirs.table">
<title>The JBoss top-level directory structure</title>
<tgroup cols="2">
@@ -526,8 +527,8 @@
</tgroup>
</table>
<para>
- <xref linkend="ch1.config-dirs.table"/> shows the the directories inside of the server configuration
- directory and their function. </para>
+ <xref linkend="ch1.config-dirs.table"/> shows the directories inside of the server configuration directory
+ and their function. </para>
<table id="ch1.config-dirs.table">
<title>The JBoss server configuration directory structure</title>
<tgroup cols="2">
@@ -638,7 +639,7 @@
<listitem>
<para>The <literal>jndi.properties</literal> file specifies the JNDI
<literal>InitialContext</literal> properties that are used within theNS-MYC10 JBoss server when
- an <literal>InitialContext</literal> is created using the no-arg constructor.</para>
+ an <literal>InitialContext</literal> is created using the no-argument constructor.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -656,7 +657,7 @@
</term>
<listitem>
<para>This file contains sample server side authentication configurations that are applicable when
- using JAAS based security. </para>
+ using JAVAS based security. </para>
</listitem>
</varlistentry>
<varlistentry>
@@ -976,7 +977,7 @@
</term>
<listitem>
<para>The <literal>jmx-console.war</literal> directory provides the JMX Console. The JMX Console
- provides a simple web interface for managing the the MBean server. </para>
+ provides a simple web interface for managing the MBean server. </para>
</listitem>
</varlistentry>
<varlistentry>
@@ -1202,7 +1203,7 @@
</varlistentry>
</variablelist>
- <para>Finally, in the EJB3 all configuration adds two additional services to su</para>
+ <para>Finally, in the EJB3 all configuration adds two additional services:</para>
<variablelist>
<varlistentry>
@@ -1231,48 +1232,28 @@
move to the <literal>bin</literal> directory and execute the <literal>run.bat</literal> or
<literal>run.sh</literal> script, as appropriate for your operating system. Your output should look like the
following and contain no error or exception messages:</para>
- <programlisting>[bin]$ sh run.sh
-
+ <programlisting>$ sh run.sh
=========================================================================
-JBoss Bootstrap Environment
+ JBoss Bootstrap Environment
-JBOSS_HOME: /tmp/jboss-4.0.3
+ JBOSS_HOME: /tmp/jboss-4.0.4.GA
-JAVA: /System/Library/Frameworks/JavaVM.framework/Home//bin/java
+ JAVA: java
-JAVA_OPTS: -server -Xms128m -Xmx128m -Dprogram.name=run.sh
+ JAVA_OPTS: -server -Xms128m -Xmx512m -Dsun.rmi.dgc.client.gcInterval=3600000
+ -Dsun.rmi.dgc.server.gcInterval=3600000 -Dprogram.name=run.sh
-CLASSPATH: /tmp/jboss-4.0.3/bin/run.jar:/System/Library/Frameworks/JavaVM.framework/Home
-/lib/tools.jar
+ CLASSPATH: /tmp/jboss-4.0.4.GA/bin/run.jar:/lib/tools.jar
=========================================================================
-15:19:42,557 INFO [Server] Starting JBoss (MX MicroKernel)...
-15:19:42,564 INFO [Server] Release ID: JBoss 4.0.3RC2 (build: CVSTag=Branch_4_0
-date=200508131954)
-15:19:42,570 INFO [Server] Home URL: file:/private/tmp/jboss-4.0.3/
-15:19:42,573 INFO [Server] Library URL: file:/private/tmp/jboss-4.0.3/lib/
-15:19:42,604 INFO [Server] Patch URL: null
-15:19:42,608 INFO [Server] Server Name: default
-15:19:42,627 INFO [Server] Server Home Dir: /private/tmp/jboss-4.0.3/server/default
-15:19:42,629 INFO [Server] Server Home URL: file:/private/tmp/jboss-4.0.3/server/default/
-15:19:42,634 INFO [Server] Server Data Dir: /private/tmp/jboss-4.0.3/server/default/data
-15:19:42,636 INFO [Server] Server Temp Dir: /private/tmp/jboss-4.0.3/server/default/tmp
-15:19:42,638 INFO [Server] Server Config URL:
-file:/private/tmp/jboss-4.0.3/server/default/conf/
-15:19:42,640 INFO [Server] Server Library URL:
-file:/private/tmp/jboss-4.0.3/server/default/lib/
-15:19:42,642 INFO [Server] Root Deployment Filename: jboss-service.xml
-15:19:42,657 INFO [Server] Starting General Purpose Architecture (GPA)...
-15:19:43,960 INFO [ServerInfo] Java version: 1.4.2_05,Apple Computer, Inc.
-15:19:43,963 INFO [ServerInfo] Java VM: Java HotSpot(TM) Client VM 1.4.2-38,"Apple
-Computer, Inc."
-15:19:43,970 INFO [ServerInfo] OS-System: Mac OS X 10.3.8,ppc
-15:19:45,243 INFO [Server] Core system initialized
+23:28:48,561 INFO [Server] Starting JBoss (MX MicroKernel)
...
-15:20:42,584 INFO [Server] JBoss (MX MicroKernel) [4.0.3RC2 (build: CVSTag=Branch_4_0
-date=200508131954)] Started in 58s:659ms</programlisting>
+23:29:09,249 INFO [Server] JBoss (MX MicroKernel) [4.0.4.GA (build:
+ CVSTag=JBoss_4_0_4_GA date=200605151000)] Started in 20s:679ms</programlisting>
+
+
<para>If your output is similar to this (accounting for installation directory differences), you are now be
ready to use JBoss.</para>
@@ -1283,10 +1264,10 @@
you pass in the name of the directory under <literal>JBOSS_DIST/server</literal> that you want to use as the
value to the <literal>-c</literal> command line option. For example, to start with the
<literal>minimal</literal> configuration file set you would specify:</para>
- <programlisting>[bin]$ ./run.sh -c minimal
+ <programlisting>$ ./run.sh -c minimal
...
-15:02:02,939 INFO [Server] JBoss (MX MicroKernel) [4.0.3RC2 (build: CVSTag=Branch_4_0
-date=200508311658)] Started in 6s:809ms</programlisting>
+23:37:41,582 INFO [Server] JBoss (MX MicroKernel) [4.0.4.GA (build:
+ CVSTag=JBoss_4_0_4_GA date=200605151000)] Started in 2s:212ms</programlisting>
@@ -1338,9 +1319,5 @@
<para>Use of the shutdown command requires a server configuration that contains
<literal>jmx-invoker-service.xml</literal> service, so the shutdown command cannot be used with the
<literal>minimal</literal> configuration. </para>
-
</chapter>
-
-
-
</book>
More information about the jboss-cvs-commits
mailing list