Clone URL (Committers only): https://cms.apache.org/redirect?new=anonymous;action=diff;uri=http://tomee.apache.org/startup.mdtext
Andrew Rodecap <[email protected]> Index: trunk/content/startup.mdtext =================================================================== --- trunk/content/startup.mdtext (revision 1655892) +++ trunk/content/startup.mdtext (working copy) @@ -1,4 +1,5 @@ Title: Startup + <a name="Startup-NAME"></a> # NAME @@ -25,24 +26,22 @@ In Windows, the remote server can be executed as follows: -*C:\openejb-3.0> bin\openejb start* +`C:\openejb-3.0> bin\openejb start` In UNIX, Linux, or Mac OS X, the deploy tool can be executed as follows: -`\[user@host openejb-3.0]([email protected]) -# ./bin/openejb start` +`[user@host openejb-3.0]([email protected])# ./bin/openejb start` Depending on your OpenEJB version, you may need to change execution bits to make the scripts executable. You can do this with the following command. -`\[user@host openejb-3.0]([email protected]) -# chmod 755 bin/openejb` +`[user@host openejb-3.0]([email protected])# chmod 755 bin/openejb` From here on out, it will be assumed that you know how to execute the right openejb script for your operating system and commands will appear in shorthand as show below. -*openejb start -help* +`openejb start -help` <a name="Startup-DESCRIPTION"></a> # DESCRIPTION @@ -63,38 +62,25 @@ <a name="Startup-OPTIONS"></a> # OPTIONS +<table> +<tr><td><code>-D<name>=<value></code></td><td>Specifies a system property passed into OpenEJB at startup.</td></tr> +<tr><td><code>--admin-bind <host></code></td><td>Sets the host to which the admin service should be bound.</td></tr> +<tr><td><code>--admin-port <int></code></td><td>Sets the port to which the admin service should be bound.</td></tr> +<tr><td><code>--conf <file></code></td><td>Sets the OpenEJB configuration to the specified file.</td></tr> +<tr><td><code>--ejbd-bind <host></code></td><td>Sets the host to which the ejbd service should be bound.</td></tr> +<tr><td><code>--ejbd-port <int></code></td><td>Sets the port to which the ejbd service should be bound.</td></tr> +<tr><td><code>--examples</code></td><td>Show examples of how to use the options.</td></tr> +<tr><td><code>-h, --help</code></td><td>Print this help message.</td></tr> +<tr><td><code>--hsql-bind <host></code></td><td>Sets the host to which the hsql service should be bound.</td></tr> +<tr><td><code>--hsql-port <int></code></td><td>Sets the port to which the hsql service should be bound.</td></tr> +<tr><td><code>--httpejbd-bind <host></code></td><td>Sets the host to which the httpejbd service should be bound.</td></tr> +<tr><td><code>--httpejbd-port <int></code></td><td>Sets the port to which the httpejbd service should be bound.</td></tr> +<tr><td><code>--local-copy <boolean></code></td><td>Instructs the container system to marshal (ie, copy) all calls between beans.</td></tr> +<tr><td><code>--telnet-bind <host></code></td><td>Sets the host to which the telnet service should be bound.</td></tr> +<tr><td><code>--telnet-port <int></code></td><td>Sets the port to which the telnet service should be bound.</td></tr> +<tr><td><code>-v, --version</code></td><td>Print the version.</td></tr> +</table> - | _-D<name>=<value>_ | Specifies a system property passed -into OpenEJB at startup. | - | _--admin-bind <host>_ | Sets the host to which the admin -service should be bound.| - | _--admin-port <int>_ | Sets the port to which the admin -service should be bound.| - | _--conf <file>_ | Sets the OpenEJB configuration to -the specified file. | - | _--ejbd-bind <host>_ | Sets the host to which the ejbd -service should be bound. | - | _--ejbd-port <int>_ | Sets the port to which the ejbd -service should be bound. | - | _--examples_ | Show examples of how to use the -options. | - | -h, --_help_ | Print this help message. | - | _--hsql-bind <host>_ | Sets the host to which the hsql -service should be bound.| - | _--hsql-port <int>_ | Sets the port to which the hsql -service should be bound.| - | _--httpejbd-bind <host>_ | Sets the host to which the httpejbd -service should be bound.| - | _--httpejbd-port <int>_ | Sets the port to which the httpejbd -service should be bound.| - | _--local-copy <boolean>_ | Instructs the container system to -marshal (ie, copy) all calls between beans. | - | _--telnet-bind <host>_ | Sets the host to which the telnet -service should be bound.| - | _--telnet-port <int>_ | Sets the port to which the telnet -service should be bound.| - | -v, --_version_ | Print the version. | - <a name="Startup-EXAMPLES"></a> # EXAMPLES @@ -108,14 +94,13 @@ The following properties would then be used to get an InitialContext from the Remote Server. +<pre><code> + java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory + java.naming.provider.url = ejbd://127.0.0.1:4201 + java.naming.security.principal = myuser + java.naming.security.credentials = mypass +</code></pre> - java.naming.factory.initial = -org.apache.openejb.client.RemoteInitialContextFactory - java.naming.provider.url = ejbd://127.0.0.1:4201 - java.naming.security.principal = myuser - java.naming.security.credentials = mypass - - <a name="Startup-Example:--conf=file"></a> ## Example: --conf=file @@ -151,7 +136,7 @@ ## CONFIG OVERRIDE EXAMPLES <a name="Startup-Example:-D<service>.bind=<address>"></a> -## Example: -D<service>.bind=<address> +## Example: `-D<service>.bind=<address>` *openejb start -Dejbd.bind=10.45.67.8* @@ -160,14 +145,13 @@ properties would then be used to get an InitialContext from the EJBd Server Service. - - java.naming.factory.initial = -org.apache.openejb.client.RemoteInitialContextFactory - java.naming.provider.url = ejbd://10.45.67.8:4201 +<pre><code> + java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory + java.naming.provider.url = ejbd://10.45.67.8:4201 java.naming.security.principal = myuser java.naming.security.credentials = mypass +</code></pre> - DNS names can also be used. *openejb start -Dejbd.bind=myhost.foo.com* @@ -175,14 +159,13 @@ The following properties would then be used to get an InitialContext from the Remote Server. - - java.naming.factory.initial = -org.apache.openejb.client.RemoteInitialContextFactory - java.naming.provider.url = ejbd://myhost.foo.com:4201 +<pre><code> + java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory + java.naming.provider.url = ejbd://myhost.foo.com:4201 java.naming.security.principal = myuser java.naming.security.credentials = mypass +</code></pre> - *openejb start -Dtelnet.bind=myhost.foo.com* The following properties would then be used to log into the server via a @@ -192,7 +175,7 @@ <a name="Startup-Example:-D<service>.port=<port>"></a> -## Example: -D<service>.port=<port> +## Example: `-D<service>.port=<port>` *openejb start -Dejbd.port=8765* @@ -201,14 +184,13 @@ The following properties would then be used to get an InitialContext from the Remote Server. - - java.naming.factory.initial = -org.apache.openejb.client.RemoteInitialContextFactory - java.naming.provider.url = ejbd://127.0.0.1:8765 +<pre><code> + java.naming.factory.initial =org.apache.openejb.client.RemoteInitialContextFactory + java.naming.provider.url = ejbd://127.0.0.1:8765 java.naming.security.principal = myuser java.naming.security.credentials = mypass +</code></pre> - *openejb start -Dhttpejbd.port=8888* The server will start up and the EJB over HTTP service will bind to IP @@ -217,16 +199,15 @@ The following properties would then be used to get an InitialContext from the HTTP/Remote Server. - - java.naming.factory.initial = -org.apache.openejb.client.RemoteInitialContextFactory - java.naming.provider.url = http://127.0.0.1:8888/openejb +<pre><code> + java.naming.factory.initial = org.apache.openejb.client.RemoteInitialContextFactory + java.naming.provider.url = http://127.0.0.1:8888/openejb java.naming.security.principal = myuser java.naming.security.credentials = mypass +</code></pre> - <a name="Startup-Example:-D<service>.only_from=<addresses>"></a> -## Example: -D<service>.only_from=<addresses> +## Example: -D<service>.only_from=<addresses> *openejb start -Dadmin.only_from=192.168.1.12* @@ -254,7 +235,7 @@ Server. <a name="Startup-Example:-D<service>.threads=<max>"></a> -## Example: -D<service>.threads=<max> +## Example: `-D<service>.threads=<max>` *openejb start -Dejbd.threads=200* @@ -262,7 +243,7 @@ Service to 200. <a name="Startup-Example:-D<service>.disabled=<true/false>"></a> -## Example: -D<service>.disabled=<true/false> +## Example: `-D<service>.disabled=<true/false>` *openejb start -Dtelnet.disabled=true* @@ -275,19 +256,20 @@ Once you start OpenEJB using the *openejb start* command the following output will be seen on the console - - Apache OpenEJB 3.0 build: 20070825-01:10 - http://tomee.apache.org/ - OpenEJB ready. - [OPENEJB:init] - OpenEJB Remote Server - ** Starting Services ** - NAME IP PORT - httpejbd 0.0.0.0 4204 - telnet 0.0.0.0 4202 - ejbd 0.0.0.0 4201 - hsql 0.0.0.0 9001 - admin thread 0.0.0.0 4200 +<pre><code> + Apache OpenEJB 3.0 build: 20070825-01:10 + http://tomee.apache.org/ + OpenEJB ready. + [OPENEJB:init] + OpenEJB Remote Server + ** Starting Services ** + NAME IP PORT + httpejbd 0.0.0.0 4204 + telnet 0.0.0.0 4202 + ejbd 0.0.0.0 4201 + hsql 0.0.0.0 9001 + admin thread 0.0.0.0 4200 ------- Ready! +</code></pre>
