From 19b992399c48629ffc046261c6895272c0087d28 Mon Sep 17 00:00:00 2001 From: Justin Bertram Date: Wed, 8 Feb 2017 15:23:52 -0600 Subject: [PATCH] ARTEMIS-954 update create command doc --- docs/user-manual/en/using-server.md | 134 +++++++++++++++++++++++++--- 1 file changed, 121 insertions(+), 13 deletions(-) diff --git a/docs/user-manual/en/using-server.md b/docs/user-manual/en/using-server.md index c76255c794..16c9a5a1ab 100644 --- a/docs/user-manual/en/using-server.md +++ b/docs/user-manual/en/using-server.md @@ -88,17 +88,36 @@ For a full list of updated properties always use: artemis create - creates a new broker instance SYNOPSIS - artemis create [--allow-anonymous] - [--cluster-password ] [--cluster-user ] - [--clustered] [--data ] [--encoding ] [--force] - [--home ] [--host ] [--java-options ] - [--password ] [--port-offset ] [--replicated] - [--role ] [--shared-store] [--silent] [--user ] [--] - + artemis create [--addresses ] [--aio] [--allow-anonymous] + [--autocreate] [--cluster-password ] + [--cluster-user ] [--clustered] [--data ] + [--default-port ] [--disable-persistence] + [--encoding ] [--failover-on-shutdown] [--force] + [--home ] [--host ] [--http-port ] + [--java-options ] [--mapped] [--max-hops ] + [--message-load-balancing ] [--name ] + [--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune] + [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor] + [--no-stomp-acceptor] [--no-web] [--password ] [--ping ] + [--port-offset ] [--queues ] [--replicated] + [--require-login] [--role ] [--shared-store] [--silent] [--slave] + [--ssl-key ] [--ssl-key-password ] + [--ssl-trust ] [--ssl-trust-password ] + [--use-client-auth] [--user ] [--verbose] [--] OPTIONS + --addresses + comma separated list of addresses + + --aio + sets the journal as asyncio. + --allow-anonymous - Enables anonymous configuration on security (Default: input) + Enables anonymous configuration on security, opposite of + --require-login (Default: input) + + --autocreate + Auto create addresses. (default: true) --cluster-password The cluster password to use for clustering. (Default: input) @@ -110,12 +129,23 @@ For a full list of updated properties always use: Enable clustering --data - Directory where ActiveMQ Data is used. Path are relative to - artemis.instance/bin + Directory where ActiveMQ Data is used. Paths are relative to + artemis.instance + + --default-port + The port number to use for the main 'artemis' acceptor (Default: + 61616) + + --disable-persistence + Disable message persistence to the journal --encoding The encoding that text files should use + --failover-on-shutdown + Valid for shared store: will shutdown trigger a failover? (Default: + false) + --force Overwrite configuration at destination directory @@ -125,20 +155,76 @@ For a full list of updated properties always use: --host The host name of the broker (Default: 0.0.0.0 or input if clustered) + --http-port + The port number to use for embedded web server (Default: 8161) + --java-options Extra java options to be passed to the profile + --mapped + Sets the journal as mapped. + + --max-hops + Number of hops on the cluster configuration + + --message-load-balancing + Load balancing policy on cluster. [ON_DEMAND (default) | STRICT | + OFF] + + --name + The name of the broker (Default: same as host) + + --nio + sets the journal as nio. + + --no-amqp-acceptor + Disable the AMQP specific acceptor. + + --no-autocreate + Disable Auto create addresses. + + --no-autotune + Disable auto tuning on the journal. + + --no-fsync + Disable usage of fdatasync (channel.force(false) from java nio) on + the journal + + --no-hornetq-acceptor + Disable the HornetQ specific acceptor. + + --no-mqtt-acceptor + Disable the MQTT specific acceptor. + + --no-stomp-acceptor + Disable the STOMP specific acceptor. + + --no-web + This will remove the web server definition from bootstrap.xml + --password The user's password (Default: input) + --ping + A comma separated string to be passed on to the broker config as + network-check-list. The broker will shutdown when all these + addresses are unreachable. + --port-offset - Off sets the default ports + Off sets the ports of every acceptor + + --queues + comma separated list of queues. --replicated Enable broker replication + --require-login + This will configure security to require user / password, opposite of + --allow-anonymous + --role - The name for the role created (Default: amq) + The name for the role created (Default: input) --shared-store Enable broker shared store @@ -147,16 +233,38 @@ For a full list of updated properties always use: It will disable all the inputs, and it would make a best guess for any required input + --slave + Valid for shared store or replication: this is a slave server? + + --ssl-key + The key store path for embedded web server + + --ssl-key-password + The key store password + + --ssl-trust + The trust store path in case of client authentication + + --ssl-trust-password + The trust store password + + --use-client-auth + If the embedded server requires client authentication + --user The username (Default: input) + --verbose + Adds more information on the execution + -- This option can be used to separate command-line options from the list of argument, (useful when arguments might be mistaken for command-line options - The instance directory to hold the broker's configuration and data + The instance directory to hold the broker's configuration and data. + Path must be writable. ```