Updated README to reflect latest CLI
Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/5d307457 Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/5d307457 Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/5d307457 Branch: refs/heads/master Commit: 5d3074579661693d5d651ffc28e8d768300930fc Parents: dfe8b14 Author: Martyn Taylor <[email protected]> Authored: Mon May 11 14:57:42 2015 +0100 Committer: Martyn Taylor <[email protected]> Committed: Mon May 11 14:57:42 2015 +0100 ---------------------------------------------------------------------- .../src/main/resources/README.html | 27 +++++++++++++------- 1 file changed, 18 insertions(+), 9 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/5d307457/artemis-distribution/src/main/resources/README.html ---------------------------------------------------------------------- diff --git a/artemis-distribution/src/main/resources/README.html b/artemis-distribution/src/main/resources/README.html index 1b7b1a9..15b7ebf 100644 --- a/artemis-distribution/src/main/resources/README.html +++ b/artemis-distribution/src/main/resources/README.html @@ -28,32 +28,41 @@ under the License. <h1>Getting Started</h1> -<h2>Starting the Broker</h2> - <b>Note (Windows users):</b> The broker currently does not support spaces in path names. For this reason the broker should be placed in a directory with no spaces in it's absolute path.</br></br> <b>Note (Windows users):</b> Examples below use the shell script `activemq` for use with linux, Windows users should use the `activemq.cmd` script with the same parameters.</br></br> -To run the ActiveMQ broker with the default configuration, run the command shown below from the "bin" directory.</br></br> +<h2>Creating a broker</h2> + +To create a broker, navigate to the distribution 'bin/' directory and run: </br></br> -$ ./activemq run</br></br> +$ ./artemis create $directory </br></br>Where $directory is the folder that you'd like the broker to be created. + +<h2>Starting the Broker</h2> + +Once the broker has been created, use the artemis (or artemis.cmd on windows) script of the under the bin directory of the newly created broker to manage the life cycle of the broker. + +To run the Apache ActiveMQ Artemis broker with the default configuration, run the command shown below from the "bin" directory of the created broker.</br></br> + +$ ./artemis run</br></br> To specify a broker configuration file:</br></br> -$ ./activemq run --config scheme:location</br></br> +$ ./artemis run --config scheme:location</br></br> e.g.</br></br> -$ ./activemq run --config xml:/home/activemq/bootstrap.xml</br></br> +$ ./artemis run --config xml:/home/activemq/bootstrap.xml</br></br> The distribution ships with a number of example configurations that can be used to get started. You can find these under the "config" directory.</br></br> -It is possible to configure run time paramters in the activemq.conf (activemq.conf.bat for windows) file under the "bin" directory. +It is possible to configure run time paramters in the artemis.conf (artemis.conf.bat for windows) file under the "bin" directory of the broker directory. + <h2>Stopping the Broker</h2> -To stop the broker please use the activemq script:</br></br> +To stop the broker please use the artemis script from the broker's bin directory:</br></br> -$ ./activemq stop</br></br> +$ ./artemis stop</br></br> <h2>Documentation</h2>
