Apache
/
activemq-artemis
mirror of https://github.com/apache/activemq-artemis.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NO-JIRA update `artemis create` samples in README.html and using-server.md

This commit is contained in:
Jiri Danek 2017-04-24 09:49:32 +02:00 committed by Clebert Suconic
parent 9401bf805c
commit abf0aa8f0c
3 changed files with 62 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/Create.java
View File

@ -215,19 +215,19 @@ public class Create extends InputAbstract {
@Option(name = "--role", description = "The name for the role created (Default: amq)") @Option(name = "--role", description = "The name for the role created (Default: amq)")
String role = "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; boolean noWeb;
@Option(name = "--queues", description = "comma separated list of queues.") @Option(name = "--queues", description = "Comma separated list of queues.")
String queues; String queues;
@Option(name = "--addresses", description = "comma separated list of addresses ") @Option(name = "--addresses", description = "Comma separated list of addresses ")
String addresses; String addresses;
@Option(name = "--aio", description = "sets the journal as asyncio.") @Option(name = "--aio", description = "Sets the journal as asyncio.")
boolean aio; boolean aio;
@Option(name = "--nio", description = "sets the journal as nio.") @Option(name = "--nio", description = "Sets the journal as nio.")
boolean nio; boolean nio;
@Option(name = "--mapped", description = "Sets the journal as mapped.") @Option(name = "--mapped", description = "Sets the journal as mapped.")

36
artemis-distribution/src/main/resources/README.html
View File

@ -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: The create process will input for any required property not specified. Example:
<PRE> <PRE>
--user: is mandatory with this configuration: --user: is a mandatory property!
Please provide the default username: Please provide the default username:
admin admin
--password: is mandatory with this configuration: --password: is mandatory with this configuration:
Please provide the default password: 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 | --require-login: is a mandatory property!
Allow anonymous access? (Y/N): Allow anonymous access?, valid values are Y,N,True,False
Y y
</PRE> </PRE>
For a full list of available options for the create process you may use: 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 artemis create - creates a new broker instance
SYNOPSIS SYNOPSIS
artemis create [--aio] [--allow-anonymous] artemis create [--addresses &lt;addresses&gt;] [--aio] [--allow-anonymous]
[--cluster-password &lt;clusterPassword&gt;] [--cluster-user &lt;clusterUser&gt;] [--autocreate] [--blocking] [--cluster-password &lt;clusterPassword&gt;]
[--clustered] [--data &lt;data&gt;] [--disable-persistence] [--cluster-user &lt;clusterUser&gt;] [--clustered] [--data &lt;data&gt;]
[--default-port &lt;defaultPort&gt;] [--disable-persistence]
[--encoding &lt;encoding&gt;] [--failover-on-shutdown] [--force] [--encoding &lt;encoding&gt;] [--failover-on-shutdown] [--force]
[--home &lt;home&gt;] [--host &lt;host&gt;] [--java-options &lt;javaOptions&gt;] [--global-max-size &lt;globalMaxSize&gt;] [--home &lt;home&gt;] [--host &lt;host&gt;]
[--max-hops &lt;maxHops&gt;] [--message-load-balancing &lt;messageLoadBalancing&gt;] [--http-host &lt;httpHost&gt;] [--http-port &lt;httpPort&gt;]
[--name &lt;name&gt;] [--nio] [--no-autotune] [--no-web] [--java-options &lt;javaOptions&gt;] [--mapped] [--max-hops &lt;maxHops&gt;]
[--password &lt;password&gt;] [--port-offset &lt;portOffset&gt;] [--queues &lt;queues&gt;] [--message-load-balancing &lt;messageLoadBalancing&gt;] [--name &lt;name&gt;]
[--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune]
[--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor]
[--no-stomp-acceptor] [--no-web] [--paging] [--password &lt;password&gt;]
[--ping &lt;ping&gt;] [--port-offset &lt;portOffset&gt;] [--queues &lt;queues&gt;]
[--replicated] [--require-login] [--role &lt;role&gt;] [--shared-store] [--replicated] [--require-login] [--role &lt;role&gt;] [--shared-store]
[--silent] [--slave] [--topics &lt;topics&gt;] [--user &lt;user&gt;] [--verbose] [--silent] [--slave] [--ssl-key &lt;sslKey&gt;]
[--] &lt;directory&gt; [--ssl-key-password &lt;sslKeyPassword&gt;] [--ssl-trust &lt;sslTrust&gt;]
[--ssl-trust-password &lt;sslTrustPassword&gt;] [--use-client-auth]
[--user &lt;user&gt;] [--verbose] [--] &lt;directory&gt;
... ...
</PRE> </PRE>

54
docs/user-manual/en/using-server.md
View File

@ -89,28 +89,30 @@ For a full list of updated properties always use:
SYNOPSIS SYNOPSIS
artemis create [--addresses <addresses>] [--aio] [--allow-anonymous] artemis create [--addresses <addresses>] [--aio] [--allow-anonymous]
[--autocreate] [--cluster-password <clusterPassword>] [--autocreate] [--blocking] [--cluster-password <clusterPassword>]
[--cluster-user <clusterUser>] [--clustered] [--data <data>] [--cluster-user <clusterUser>] [--clustered] [--data <data>]
[--default-port <defaultPort>] [--disable-persistence] [--default-port <defaultPort>] [--disable-persistence]
[--encoding <encoding>] [--failover-on-shutdown] [--force] [--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>] [--java-options <javaOptions>] [--mapped] [--max-hops <maxHops>]
[--message-load-balancing <messageLoadBalancing>] [--name <name>] [--message-load-balancing <messageLoadBalancing>] [--name <name>]
[--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune] [--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune]
[--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor] [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor]
[--no-stomp-acceptor] [--no-web] [--password <password>] [--ping <ping>] [--no-stomp-acceptor] [--no-web] [--paging] [--password <password>]
[--port-offset <portOffset>] [--queues <queues>] [--replicated] [--ping <ping>] [--port-offset <portOffset>] [--queues <queues>]
[--require-login] [--role <role>] [--shared-store] [--silent] [--slave] [--replicated] [--require-login] [--role <role>] [--shared-store]
[--ssl-key <sslKey>] [--ssl-key-password <sslKeyPassword>] [--silent] [--slave] [--ssl-key <sslKey>]
[--ssl-trust <sslTrust>] [--ssl-trust-password <sslTrustPassword>] [--ssl-key-password <sslKeyPassword>] [--ssl-trust <sslTrust>]
[--use-client-auth] [--user <user>] [--verbose] [--] <directory> [--ssl-trust-password <sslTrustPassword>] [--use-client-auth]
[--user <user>] [--verbose] [--] <directory>
OPTIONS OPTIONS
--addresses <addresses> --addresses <addresses>
comma separated list of addresses Comma separated list of addresses
--aio --aio
sets the journal as asyncio. Sets the journal as asyncio.
--allow-anonymous --allow-anonymous
Enables anonymous configuration on security, opposite of Enables anonymous configuration on security, opposite of
@ -119,6 +121,10 @@ For a full list of updated properties always use:
--autocreate --autocreate
Auto create addresses. (default: true) Auto create addresses. (default: true)
--blocking
Block producers when address becomes full, opposite of --paging
(Default: false)
--cluster-password <clusterPassword> --cluster-password <clusterPassword>
The cluster password to use for clustering. (Default: input) The cluster password to use for clustering. (Default: input)
@ -149,12 +155,19 @@ For a full list of updated properties always use:
--force --force
Overwrite configuration at destination directory 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> --home <home>
Directory where ActiveMQ Artemis is installed Directory where ActiveMQ Artemis is installed
--host <host> --host <host>
The host name of the broker (Default: 0.0.0.0 or input if clustered) 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> --http-port <httpPort>
The port number to use for embedded web server (Default: 8161) 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) The name of the broker (Default: same as host)
--nio --nio
sets the journal as nio. Sets the journal as nio.
--no-amqp-acceptor --no-amqp-acceptor
Disable the AMQP specific acceptor. Disable the AMQP specific acceptor.
@ -200,7 +213,11 @@ For a full list of updated properties always use:
Disable the STOMP specific acceptor. Disable the STOMP specific acceptor.
--no-web --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> --password <password>
The user's password (Default: input) 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 Off sets the ports of every acceptor
--queues <queues> --queues <queues>
comma separated list of queues. Comma separated list of queues.
--replicated --replicated
Enable broker replication Enable broker replication
@ -224,7 +241,7 @@ For a full list of updated properties always use:
--allow-anonymous --allow-anonymous
--role <role> --role <role>
The name for the role created (Default: input) The name for the role created (Default: amq)
--shared-store --shared-store
Enable broker 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 ./artemis create /usr/server
Creating ActiveMQ Artemis instance at: /user/server Creating ActiveMQ Artemis instance at: /user/server
--user: is mandatory with this configuration: --user: is a mandatory property!
Please provide the default username: Please provide the default username:
admin admin
@ -282,10 +299,13 @@ Some of these properties may be mandatory in certain configurations and the syst
Please provide the default password: Please provide the default password:
--allow-anonymous: is mandatory with this configuration: --allow-anonymous | --require-login: is a mandatory property!
Allow anonymous access? (Y/N): Allow anonymous access?, valid values are Y,N,True,False
y 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: You can now start the broker by executing:
"/user/server/bin/artemis" run "/user/server/bin/artemis" run