Repository: activemq-artemis Updated Branches: refs/heads/master 9401bf805 -> 4970d99fd
NO-JIRA update `artemis create` samples in README.html and using-server.md Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/abf0aa8f Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/abf0aa8f Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/abf0aa8f Branch: refs/heads/master Commit: abf0aa8f0cae6b9aa27669ce41a1760e83f002df Parents: 9401bf8 Author: Jiri Danek <[email protected]> Authored: Mon Apr 24 09:49:32 2017 +0200 Committer: Clebert Suconic <[email protected]> Committed: Fri Apr 28 12:49:14 2017 -0400 ---------------------------------------------------------------------- .../activemq/artemis/cli/commands/Create.java | 10 ++-- .../src/main/resources/README.html | 36 +++++++------ docs/user-manual/en/using-server.md | 54 ++++++++++++++------ 3 files changed, 62 insertions(+), 38 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/abf0aa8f/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java ---------------------------------------------------------------------- diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java index 3468cbf..66bffe2 100644 --- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java +++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java @@ -215,19 +215,19 @@ public class Create extends InputAbstract { @Option(name = "--role", description = "The name for the role created (Default: amq)") String role = "amq"; - @Option(name = "--no-web", description = "remove the web-server definition from bootstrap.xml") + @Option(name = "--no-web", description = "Remove the web-server definition from bootstrap.xml") boolean noWeb; - @Option(name = "--queues", description = "comma separated list of queues.") + @Option(name = "--queues", description = "Comma separated list of queues.") String queues; - @Option(name = "--addresses", description = "comma separated list of addresses ") + @Option(name = "--addresses", description = "Comma separated list of addresses ") String addresses; - @Option(name = "--aio", description = "sets the journal as asyncio.") + @Option(name = "--aio", description = "Sets the journal as asyncio.") boolean aio; - @Option(name = "--nio", description = "sets the journal as nio.") + @Option(name = "--nio", description = "Sets the journal as nio.") boolean nio; @Option(name = "--mapped", description = "Sets the journal as mapped.") http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/abf0aa8f/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 d9fb198..e309c81 100644 --- a/artemis-distribution/src/main/resources/README.html +++ b/artemis-distribution/src/main/resources/README.html @@ -42,20 +42,17 @@ $ ./artemis create $directory <br><br>Where $directory is the folder that you'd The create process will input for any required property not specified. Example: <PRE> ---user: is mandatory with this configuration: +--user: is a mandatory property! Please provide the default username: admin --password: is mandatory with this configuration: Please provide the default password: ---role: is mandatory with this configuration: -Please provide the default role: -admin ---allow-anonymous | --require-login: is mandatory with this configuration: -Allow anonymous access? (Y/N): -Y +--allow-anonymous | --require-login: is a mandatory property! +Allow anonymous access?, valid values are Y,N,True,False +y </PRE> For a full list of available options for the create process you may use: @@ -66,17 +63,24 @@ NAME artemis create - creates a new broker instance SYNOPSIS - artemis create [--aio] [--allow-anonymous] - [--cluster-password <clusterPassword>] [--cluster-user <clusterUser>] - [--clustered] [--data <data>] [--disable-persistence] + artemis create [--addresses <addresses>] [--aio] [--allow-anonymous] + [--autocreate] [--blocking] [--cluster-password <clusterPassword>] + [--cluster-user <clusterUser>] [--clustered] [--data <data>] + [--default-port <defaultPort>] [--disable-persistence] [--encoding <encoding>] [--failover-on-shutdown] [--force] - [--home <home>] [--host <host>] [--java-options <javaOptions>] - [--max-hops <maxHops>] [--message-load-balancing <messageLoadBalancing>] - [--name <name>] [--nio] [--no-autotune] [--no-web] - [--password <password>] [--port-offset <portOffset>] [--queues <queues>] + [--global-max-size <globalMaxSize>] [--home <home>] [--host <host>] + [--http-host <httpHost>] [--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] [--paging] [--password <password>] + [--ping <ping>] [--port-offset <portOffset>] [--queues <queues>] [--replicated] [--require-login] [--role <role>] [--shared-store] - [--silent] [--slave] [--topics <topics>] [--user <user>] [--verbose] - [--] <directory> + [--silent] [--slave] [--ssl-key <sslKey>] + [--ssl-key-password <sslKeyPassword>] [--ssl-trust <sslTrust>] + [--ssl-trust-password <sslTrustPassword>] [--use-client-auth] + [--user <user>] [--verbose] [--] <directory> ... </PRE> http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/abf0aa8f/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 16c9a5a..b1e2c91 100644 --- a/docs/user-manual/en/using-server.md +++ b/docs/user-manual/en/using-server.md @@ -89,28 +89,30 @@ For a full list of updated properties always use: SYNOPSIS artemis create [--addresses <addresses>] [--aio] [--allow-anonymous] - [--autocreate] [--cluster-password <clusterPassword>] + [--autocreate] [--blocking] [--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>] + [--global-max-size <globalMaxSize>] [--home <home>] [--host <host>] + [--http-host <httpHost>] [--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> + [--no-stomp-acceptor] [--no-web] [--paging] [--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 + Comma separated list of addresses --aio - sets the journal as asyncio. + Sets the journal as asyncio. --allow-anonymous Enables anonymous configuration on security, opposite of @@ -119,6 +121,10 @@ For a full list of updated properties always use: --autocreate Auto create addresses. (default: true) + --blocking + Block producers when address becomes full, opposite of --paging + (Default: false) + --cluster-password <clusterPassword> The cluster password to use for clustering. (Default: input) @@ -149,12 +155,19 @@ For a full list of updated properties always use: --force Overwrite configuration at destination directory + --global-max-size <globalMaxSize> + Maximum amount of memory which message data may consume (Default: + Undefined, half of the system's memory) + --home <home> Directory where ActiveMQ Artemis is installed --host <host> The host name of the broker (Default: 0.0.0.0 or input if clustered) + --http-host <httpHost> + The host name to use for embedded web server (Default: localhost) + --http-port <httpPort> The port number to use for embedded web server (Default: 8161) @@ -175,7 +188,7 @@ For a full list of updated properties always use: The name of the broker (Default: same as host) --nio - sets the journal as nio. + Sets the journal as nio. --no-amqp-acceptor Disable the AMQP specific acceptor. @@ -200,7 +213,11 @@ For a full list of updated properties always use: Disable the STOMP specific acceptor. --no-web - This will remove the web server definition from bootstrap.xml + Remove the web-server definition from bootstrap.xml + + --paging + Page messages to disk when address becomes full, opposite of + --blocking (Default: true) --password <password> The user's password (Default: input) @@ -214,7 +231,7 @@ For a full list of updated properties always use: Off sets the ports of every acceptor --queues <queues> - comma separated list of queues. + Comma separated list of queues. --replicated Enable broker replication @@ -224,7 +241,7 @@ For a full list of updated properties always use: --allow-anonymous --role <role> - The name for the role created (Default: input) + The name for the role created (Default: amq) --shared-store Enable broker shared store @@ -274,7 +291,7 @@ Some of these properties may be mandatory in certain configurations and the syst ./artemis create /usr/server Creating ActiveMQ Artemis instance at: /user/server - --user: is mandatory with this configuration: + --user: is a mandatory property! Please provide the default username: admin @@ -282,10 +299,13 @@ Some of these properties may be mandatory in certain configurations and the syst Please provide the default password: - --allow-anonymous: is mandatory with this configuration: - Allow anonymous access? (Y/N): + --allow-anonymous | --require-login: is a mandatory property! + Allow anonymous access?, valid values are Y,N,True,False y + Auto tuning journal ... + done! Your system can make 0.34 writes per millisecond, your journal-buffer-timeout will be 2956000 + You can now start the broker by executing: "/user/server/bin/artemis" run
