ARTEMIS-954 update create command doc
Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/19b99239 Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/19b99239 Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/19b99239 Branch: refs/heads/master Commit: 19b992399c48629ffc046261c6895272c0087d28 Parents: 5367370 Author: Justin Bertram <[email protected]> Authored: Wed Feb 8 15:23:52 2017 -0600 Committer: Clebert Suconic <[email protected]> Committed: Wed Feb 8 18:12:33 2017 -0500 ---------------------------------------------------------------------- docs/user-manual/en/using-server.md | 134 ++++++++++++++++++++++++++++--- 1 file changed, 121 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/19b99239/docs/user-manual/en/using-server.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/using-server.md b/docs/user-manual/en/using-server.md index c76255c..16c9a5a 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 <clusterPassword>] [--cluster-user <clusterUser>] - [--clustered] [--data <data>] [--encoding <encoding>] [--force] - [--home <home>] [--host <host>] [--java-options <javaOptions>] - [--password <password>] [--port-offset <portOffset>] [--replicated] - [--role <role>] [--shared-store] [--silent] [--user <user>] [--] - <directory> + artemis create [--addresses <addresses>] [--aio] [--allow-anonymous] + [--autocreate] [--cluster-password <clusterPassword>] + [--cluster-user <clusterUser>] [--clustered] [--data <data>] + [--default-port <defaultPort>] [--disable-persistence] + [--encoding <encoding>] [--failover-on-shutdown] [--force] + [--home <home>] [--host <host>] [--http-port <httpPort>] + [--java-options <javaOptions>] [--mapped] [--max-hops <maxHops>] + [--message-load-balancing <messageLoadBalancing>] [--name <name>] + [--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune] + [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor] + [--no-stomp-acceptor] [--no-web] [--password <password>] [--ping <ping>] + [--port-offset <portOffset>] [--queues <queues>] [--replicated] + [--require-login] [--role <role>] [--shared-store] [--silent] [--slave] + [--ssl-key <sslKey>] [--ssl-key-password <sslKeyPassword>] + [--ssl-trust <sslTrust>] [--ssl-trust-password <sslTrustPassword>] + [--use-client-auth] [--user <user>] [--verbose] [--] <directory> OPTIONS + --addresses <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 <clusterPassword> 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 <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 <defaultPort> + The port number to use for the main 'artemis' acceptor (Default: + 61616) + + --disable-persistence + Disable message persistence to the journal --encoding <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 <host> The host name of the broker (Default: 0.0.0.0 or input if clustered) + --http-port <httpPort> + The port number to use for embedded web server (Default: 8161) + --java-options <javaOptions> Extra java options to be passed to the profile + --mapped + Sets the journal as mapped. + + --max-hops <maxHops> + Number of hops on the cluster configuration + + --message-load-balancing <messageLoadBalancing> + Load balancing policy on cluster. [ON_DEMAND (default) | STRICT | + OFF] + + --name <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 <password> The user's password (Default: input) + --ping <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 <portOffset> - Off sets the default ports + Off sets the ports of every acceptor + + --queues <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 <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 <sslKey> + The key store path for embedded web server + + --ssl-key-password <sslKeyPassword> + The key store password + + --ssl-trust <sslTrust> + The trust store path in case of client authentication + + --ssl-trust-password <sslTrustPassword> + The trust store password + + --use-client-auth + If the embedded server requires client authentication + --user <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 <directory> - 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. ```
