[jboss-cvs] JBossAS SVN: r77221 - in projects/docs/enterprise: 4.3.3/Getting_Started/en-US and 1 other directory.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Wed Aug 20 01:29:56 EDT 2008
Author: irooskov at redhat.com
Date: 2008-08-20 01:29:55 -0400 (Wed, 20 Aug 2008)
New Revision: 77221
Modified:
projects/docs/enterprise/4.2.5/Getting_Started/en-US/Start_Stop_Server.xml
projects/docs/enterprise/4.2.5/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml
projects/docs/enterprise/4.3.3/Getting_Started/en-US/Start_Stop_Server.xml
projects/docs/enterprise/4.3.3/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml
Log:
updated Getting Started Guide refering to running JBoss as a service on Windows. This resolves the JIRA JBPAPP-1090
Modified: projects/docs/enterprise/4.2.5/Getting_Started/en-US/Start_Stop_Server.xml
===================================================================
--- projects/docs/enterprise/4.2.5/Getting_Started/en-US/Start_Stop_Server.xml 2008-08-20 04:40:58 UTC (rev 77220)
+++ projects/docs/enterprise/4.2.5/Getting_Started/en-US/Start_Stop_Server.xml 2008-08-20 05:29:55 UTC (rev 77221)
@@ -124,21 +124,118 @@
You can configure the server to run as a service under Microsoft Windows, and configure it to start automatically if desired.
</para>
<para>
- Download the <literal>JavaService</literal> package from <ulink url="http://forge.objectweb.org/projects/javaservice/">http://forge.objectweb.org/projects/javaservice/</ulink>.
+ There are two ways that the JBoss Enterprise Application Server can be run under Windows.
</para>
+ <formalpara>
+ <title>Option 1. Use JBoss Native for Windows</title>
+ <para>
+ You can use <ulink url="http://labs.jboss.com/jbossweb/downloads/">JBossNative</ulink>. Download the appropriate version based on your system and go through the README-service.txt which lists down the steps for running JBoss as a service.
+ </para>
+ </formalpara>
+ <formalpara>
+ <title>Option 2. Use the JavaServiceWrapper</title>
+ <para>
+ You can use <ulink url="http://wrapper.tanukisoftware.org/doc/english/integrate-simple-win.html">Java Service Wrapper</ulink> and manage it using the <ulink url="http://wrapper.tanukisoftware.org/doc/english/jmx.html#jboss">JMX</ulink>.
+ </para>
+ </formalpara>
<para>
- Unzip the package and use the <literal>JBossInstall.bat</literal> file to install the JBoss service. You must set the <literal>JAVA_HOME</literal> and <literal>JBOSS_HOME</literal> environment variables to point to the <literal>jdk</literal> and <literal>jboss-as</literal> directories before running <literal>JBossInstall.bat</literal>. Run <literal>JBossInstall.bat</literal> with the following syntax:
+ Unzip the wrapper zip file, and do the following:
</para>
-<screen>JBossInstall.bat <replaceable><depends></replaceable> [-auto | -manual]</screen>
+<programlisting>
+copy WRAPPER_HOME\bin\Wrapper.exe %JBOSS_HOME%\bin\Wrapper.exe
+copy WRAPPER_HOME\lib\Wrapper.DLL %JBOSS_HOME%\lib\Wrapper.DLL
+copy WRAPPER_HOME\lib\wrapper.jar %JBOSS_HOME%\lib\wrapper.jar
+mkdir %JBOSS_HOME%\server\YOURCONFIG\wrapper
+</programlisting>
<para>
- Where <replaceable><depends></replaceable> is the name of any service that the JBoss AS server depends on, such as the <literal>mysql</literal> database service.
+ Create a <filename>wrapper.conf</filename> file inside the <emphasis>%JBOSS_HOME%\server\YOURCONFIG\wrapper</emphasis> directory, with the below contents:
</para>
+<programlisting>
+wrapper.java.command=D:/Java/jdk1.5.0_14/bin/java
+
+wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp
+
+wrapper.java.classpath.1=%JBOSS_HOME%/lib/wrapper.jar
+wrapper.java.classpath.2=%JAVA_HOME%/bin/java/lib/tools.jar
+wrapper.java.classpath.3=./run.jar
+
+wrapper.java.library.path.1=%JBOSS_HOME%/lib
+
+# these are the JAVA_OPTS
+wrapper.java.additional.1=-server
+# enviroment variables - define the ones that match your desired environment
+wrapper.java.additional.2=-Denviromnment.variable=value
+# memory parameters - define the ones that match your desired environment
+wrapper.java.additional.3=-Xms64m
+wrapper.java.additional.4=-Xmx96m
+# If you need serialization suppport
+wrapper.java.additional.5=-Dsession.serialization.jboss=true
+
+wrapper.app.parameter.1=org.jboss.Main
+# Parameters to be passed to the application (Jboss)
+# Define server name (configuration) - If you need a config that is different than the "default" or need to run multiple configs
+wrapper.app.parameter.2=-c YOURCONFIG
+# Define listening IP - If you have more than one IP or want to indicate to listen on a specific IP
+wrapper.app.parameter.3=-b aaa.bbb.ccc.ddd
+# wrapper log location
+wrapper.logfile=%JBOSS_HOME%/server/YOURCONFIG/log/wrapper.log
+
+# You must not change below parameters without first uninstall the service
+# service name
+wrapper.ntservice.name=JbossYOURCONFIG
+# service display name
+wrapper.ntservice.displayname=JBoss Server YOURCONFIG
+</programlisting>
<para>
- Once the service is installed the server can be started by using the command <literal>net start JBoss</literal>, and stopped with the command <literal>net stop JBoss</literal>.
+ The service can be tested by running the following commands:
</para>
+<programlisting>
+cd %JBOSS_HOME%\bin\
+wrapper.exe -c %JBOSS_HOME%\server\YOURCONFIG\wrapper\wrapper.conf
+</programlisting>
<para>
- Please refer to the documentation included in the <literal>JavaService</literal> package for further information.
+ To now install the service, execute:
</para>
+<programlisting>
+cd %JBOSS_HOME%\bin\
+wrapper.exe -i %JBOSS_HOME%\server\YOURCONFIG\wrapper\wrapper.conf
+</programlisting>
+ <para>
+ If at some point you wish to uninstall the JavaServiceWrapper, execute:
+ </para>
+<programlisting>
+cd %JBOSS_HOME%\bin\
+wrapper.exe -r %JBOSS_HOME%\server\YOURCONFIG\wrapper\wrapper.conf
+</programlisting>
+
+ <warning>
+ <para>
+ Make sure your JBOSS_HOME environment variable is set correctly as the wrapper does not set this automaticly.
+ </para>
+ </warning>
+ <para>
+ As a final check, make sure that your <filename>java-service-wrapper-service.xml</filename> file looks like the following:
+ </para>
+ <screen>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE server>
+<server>
+ <mbean code="org.tanukisoftware.wrapper.jmx.WrapperManager"name="JavaServiceWrapper:service=WrapperManager"/>
+
+ <mbean code="org.tanukisoftware.wrapper.jmx.WrapperManagerTesting"name="JavaServiceWrapper:service=WrapperManagerTesting"/>
+</server>
+ </screen>
+ <note>
+ <para>
+ Using <ulink url="http://wiki.jboss.org/auth/wiki/JavaService">JavaService</ulink> is no longer a recommended way to run JBoss as a service on Windows.
+ </para>
+ <para>
+ JavaService has a bug where it will not pass either Xss or XX:ThreadStackStize? arguemnts to the jvm properly. This results are that each thread stack is 1MB. Under load this will most likely fail with an "java.lang.OutOfMemoryError: unable to create new native thread" error. The fix for this error is to lower the thread stack size. Since JavaService does not allow the thread stack size to be set, there will be no solution once an application has run into this error.
+ </para>
+ <para>
+ The limit on memory allocation can also cause tiles to slow down in JBoss when many applications are deployed.
+ </para>
+ </note>
</section>
</section>
Modified: projects/docs/enterprise/4.2.5/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml
===================================================================
--- projects/docs/enterprise/4.2.5/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml 2008-08-20 04:40:58 UTC (rev 77220)
+++ projects/docs/enterprise/4.2.5/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml 2008-08-20 05:29:55 UTC (rev 77221)
@@ -20,7 +20,7 @@
When the JBoss Server is running, you can get a live view of the server by going to the JMX console application at <ulink url="http://localhost:8080/jmx-console"></ulink>. You should see something similar to <xref linkend="The_JMX_Console-View_of_the_JMX_Management_Console_Web_Application" />.
</para>
<para>
- By default the access rights to the JMX console are commented out. If you cannot access the JMX console using the address stated above because of a permissions error go to the <emphasis>conf/props/</ephasis> directory of the server configuration you are deploying and uncomment the admin <property>userid</property> and <property>password</property> code within the <filename>jmx-console-users.properties</filename> file. This will now allow the admin user to access the JMX console using the username and password combination specified within the <filename>jmx-console-users.properties</filename> file.
+ By default the access rights to the JMX console are commented out. If you cannot access the JMX console using the address stated above because of a permissions error go to the <emphasis>conf/props/</emphasis> directory of the server configuration you are deploying and uncomment the admin <property>userid</property> and <property>password</property> code within the <filename>jmx-console-users.properties</filename> file. This will now allow the admin user to access the JMX console using the username and password combination specified within the <filename>jmx-console-users.properties</filename> file.
</para>
<para>
The JMX Console is the JBoss Management Console which provides a raw view of the JMX MBeans which make up the server. They can provide a lot of information about the running server and allow you to modify its configuration, start and stop components and so on.
Modified: projects/docs/enterprise/4.3.3/Getting_Started/en-US/Start_Stop_Server.xml
===================================================================
--- projects/docs/enterprise/4.3.3/Getting_Started/en-US/Start_Stop_Server.xml 2008-08-20 04:40:58 UTC (rev 77220)
+++ projects/docs/enterprise/4.3.3/Getting_Started/en-US/Start_Stop_Server.xml 2008-08-20 05:29:55 UTC (rev 77221)
@@ -127,21 +127,118 @@
You can configure the server to run as a service under Microsoft Windows, and configure it to start automatically if desired.
</para>
<para>
- Download the <literal>JavaService</literal> package from <ulink url="http://forge.objectweb.org/projects/javaservice/">http://forge.objectweb.org/projects/javaservice/</ulink>.
+ There are two ways that the JBoss Enterprise Application Server can be run under Windows.
</para>
- <para>
- Unzip the package and use the <literal>JBossInstall.bat</literal> file to install the JBoss service. You must set the <literal>JAVA_HOME</literal> and <literal>JBOSS_HOME</literal> environment variables to point to the <literal>jdk</literal> and <literal>jboss-as</literal> directories before running <literal>JBossInstall.bat</literal>. Run <literal>JBossInstall.bat</literal> with the following syntax:
- </para>
-<screen>JBossInstall.bat <replaceable><depends></replaceable> [-auto | -manual]</screen>
- <para>
- Where <replaceable><depends></replaceable> is the name of any service that the JBoss AS server depends on, such as the <literal>mysql</literal> database service.
- </para>
- <para>
- Once the service is installed the server can be started by using the command <literal>net start JBoss</literal>, and stopped with the command <literal>net stop JBoss</literal>.
- </para>
- <para>
- Please refer to the documentation included in the <literal>JavaService</literal> package for further information.
- </para>
+ <formalpara>
+ <title>Option 1. Use JBoss Native for Windows</title>
+ <para>
+ You can use <ulink url="http://labs.jboss.com/jbossweb/downloads/">JBossNative</ulink>. Download the appropriate version based on your system and go through the README-service.txt which lists down the steps for running JBoss as a service.
+ </para>
+ </formalpara>
+ <formalpara>
+ <title>Option 2. Use the JavaServiceWrapper</title>
+ <para>
+ You can use <ulink url="http://wrapper.tanukisoftware.org/doc/english/integrate-simple-win.html">Java Service Wrapper</ulink> and manage it using the <ulink url="http://wrapper.tanukisoftware.org/doc/english/jmx.html#jboss">JMX</ulink>.
+ </para>
+ </formalpara>
+ <para>
+ Unzip the wrapper zip file, and do the following:
+ </para>
+<programlisting>
+copy WRAPPER_HOME\bin\Wrapper.exe %JBOSS_HOME%\bin\Wrapper.exe
+copy WRAPPER_HOME\lib\Wrapper.DLL %JBOSS_HOME%\lib\Wrapper.DLL
+copy WRAPPER_HOME\lib\wrapper.jar %JBOSS_HOME%\lib\wrapper.jar
+mkdir %JBOSS_HOME%\server\YOURCONFIG\wrapper
+</programlisting>
+ <para>
+ Create a <filename>wrapper.conf</filename> file inside the <emphasis>%JBOSS_HOME%\server\YOURCONFIG\wrapper</emphasis> directory, with the below contents:
+ </para>
+<programlisting>
+wrapper.java.command=D:/Java/jdk1.5.0_14/bin/java
+
+wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp
+
+wrapper.java.classpath.1=%JBOSS_HOME%/lib/wrapper.jar
+wrapper.java.classpath.2=%JAVA_HOME%/bin/java/lib/tools.jar
+wrapper.java.classpath.3=./run.jar
+
+wrapper.java.library.path.1=%JBOSS_HOME%/lib
+
+# these are the JAVA_OPTS
+wrapper.java.additional.1=-server
+# enviroment variables - define the ones that match your desired environment
+wrapper.java.additional.2=-Denviromnment.variable=value
+# memory parameters - define the ones that match your desired environment
+wrapper.java.additional.3=-Xms64m
+wrapper.java.additional.4=-Xmx96m
+# If you need serialization suppport
+wrapper.java.additional.5=-Dsession.serialization.jboss=true
+
+wrapper.app.parameter.1=org.jboss.Main
+# Parameters to be passed to the application (Jboss)
+# Define server name (configuration) - If you need a config that is different than the "default" or need to run multiple configs
+wrapper.app.parameter.2=-c YOURCONFIG
+# Define listening IP - If you have more than one IP or want to indicate to listen on a specific IP
+wrapper.app.parameter.3=-b aaa.bbb.ccc.ddd
+# wrapper log location
+wrapper.logfile=%JBOSS_HOME%/server/YOURCONFIG/log/wrapper.log
+
+# You must not change below parameters without first uninstall the service
+# service name
+wrapper.ntservice.name=JbossYOURCONFIG
+# service display name
+wrapper.ntservice.displayname=JBoss Server YOURCONFIG
+</programlisting>
+ <para>
+ The service can be tested by running the following commands:
+ </para>
+<programlisting>
+cd %JBOSS_HOME%\bin\
+wrapper.exe -c %JBOSS_HOME%\server\YOURCONFIG\wrapper\wrapper.conf
+</programlisting>
+ <para>
+ To now install the service, execute:
+ </para>
+<programlisting>
+cd %JBOSS_HOME%\bin\
+wrapper.exe -i %JBOSS_HOME%\server\YOURCONFIG\wrapper\wrapper.conf
+</programlisting>
+ <para>
+ If at some point you wish to uninstall the JavaServiceWrapper, execute:
+ </para>
+<programlisting>
+cd %JBOSS_HOME%\bin\
+wrapper.exe -r %JBOSS_HOME%\server\YOURCONFIG\wrapper\wrapper.conf
+</programlisting>
+
+ <warning>
+ <para>
+ Make sure your JBOSS_HOME environment variable is set correctly as the wrapper does not set this automaticly.
+ </para>
+ </warning>
+ <para>
+ As a final check, make sure that your <filename>java-service-wrapper-service.xml</filename> file looks like the following:
+ </para>
+<screen>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE server>
+<server>
+ <mbean code="org.tanukisoftware.wrapper.jmx.WrapperManager"name="JavaServiceWrapper:service=WrapperManager"/>
+
+ <mbean code="org.tanukisoftware.wrapper.jmx.WrapperManagerTesting"name="JavaServiceWrapper:service=WrapperManagerTesting"/>
+</server>
+</screen>
+ <note>
+ <para>
+ Using <ulink url="http://wiki.jboss.org/auth/wiki/JavaService">JavaService</ulink> is no longer a recommended way to run JBoss as a service on Windows.
+ </para>
+ <para>
+ JavaService has a bug where it will not pass either Xss or XX:ThreadStackStize? arguemnts to the jvm properly. This results are that each thread stack is 1MB. Under load this will most likely fail with an "java.lang.OutOfMemoryError: unable to create new native thread" error. The fix for this error is to lower the thread stack size. Since JavaService does not allow the thread stack size to be set, there will be no solution once an application has run into this error.
+ </para>
+ <para>
+ The limit on memory allocation can also cause tiles to slow down in JBoss when many applications are deployed.
+ </para>
+ </note>
</section>
</section>
Modified: projects/docs/enterprise/4.3.3/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml
===================================================================
--- projects/docs/enterprise/4.3.3/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml 2008-08-20 04:40:58 UTC (rev 77220)
+++ projects/docs/enterprise/4.3.3/Getting_Started/en-US/The_JBoss_Server___A_Quick_Tour.xml 2008-08-20 05:29:55 UTC (rev 77221)
@@ -20,7 +20,7 @@
When the JBoss Server is running, you can get a live view of the server by going to the JMX console application at <ulink url="http://localhost:8080/jmx-console"></ulink>. You should see something similar to <xref linkend="The_JMX_Console-View_of_the_JMX_Management_Console_Web_Application" />.
</para>
<para>
- By default the access rights to the JMX console are commented out. If you cannot access the JMX console using the address stated above because of a permissions error go to the <emphasis>conf/props/</ephasis> directory of the server configuration you are deploying and uncomment the admin <property>userid</property> and <property>password</property> code within the <filename>jmx-console-users.properties</filename> file. This will now allow the admin user to access the JMX console using the username and password combination specified within the <filename>jmx-console-users.properties</filename> file.
+ By default the access rights to the JMX console are commented out. If you cannot access the JMX console using the address stated above because of a permissions error go to the <emphasis>conf/props/</emphasis> directory of the server configuration you are deploying and uncomment the admin <property>userid</property> and <property>password</property> code within the <filename>jmx-console-users.properties</filename> file. This will now allow the admin user to access the JMX console using the username and password combination specified within the <filename>jmx-console-users.properties</filename> file.
</para>
<para>
The JMX Console is the JBoss Management Console which provides a raw view of the JMX MBeans which make up the server. They can provide a lot of information about the running server and allow you to modify its configuration, start and stop components and so on.
More information about the jboss-cvs-commits
mailing list