README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <!--
   3 Licensed to the Apache Software Foundation (ASF) under one
   4 or more contributor license agreements.  See the NOTICE file
   5 distributed with this work for additional information
   6 regarding copyright ownership.  The ASF licenses this file
   7 to you under the Apache License, Version 2.0 (the
   8 "License"); you may not use this file except in compliance
   9 with the License.  You may obtain a copy of the License at
  10
  11   http://www.apache.org/licenses/LICENSE-2.0
  12
  13 Unless required by applicable law or agreed to in writing,
  14 software distributed under the License is distributed on an
  15 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16 KIND, either express or implied.  See the License for the
  17 specific language governing permissions and limitations
  18 under the License.
  19 -->
  20
  21 <html>
  22 <head>
  23    <meta content="text/html; charset=ISO-8859-1"
  24          http-equiv="content-type">
  25    <title>Apache ActiveMQ Artemis README</title>
  26    <link rel="stylesheet" type="text/css" href="./examples/common/common.css" />
  27    <link rel="stylesheet" type="text/css" href="./examples/common/prettify.css" />
  28    <script type="text/javascript" src="./examples/common/prettify.js"></script>
  29 </head>
  30 <body>
  31
  32 <h1>Getting Started</h1>
  33
  34 <b>Note (Windows users):</b> Examples below use the shell script `artemis` for use with linux, Windows users should use the `artemis.cmd` script with the same parameters.<br><br>
  35
  36 <h2>Creating a broker</h2>
  37
  38 To create a broker, navigate to the distribution 'bin/' directory and run: <br><br>
  39
  40 $ ./artemis create $directory <br><br>Where $directory is the folder that you'd like the broker to be created.
  41
  42 The create process will input for any required property not specified. Example:
  43
  44 <PRE>
  45 --user: is a mandatory property!
  46 Please provide the default username:
  47 admin
  48
  49 --password: is mandatory with this configuration:
  50 Please provide the default password:
  51
  52
  53 --allow-anonymous | --require-login: is a mandatory property!
  54 Allow anonymous access?, valid values are Y,N,True,False
  55 y
  56 </PRE>
  57
  58 For a full list of available options for the create process you may use:
  59
  60 $ ./artemis help create
  61 <PRE>
  62 NAME
  63         artemis create - creates a new broker instance
  64
  65 SYNOPSIS
  66         artemis create [--addresses &lt;addresses&gt;] [--aio] [--allow-anonymous]
  67                 [--autocreate] [--blocking] [--cluster-password &lt;clusterPassword&gt;]
  68                 [--cluster-user &lt;clusterUser&gt;] [--clustered] [--data &lt;data&gt;]
  69                 [--default-port &lt;defaultPort&gt;] [--disable-persistence]
  70                 [--encoding &lt;encoding&gt;] [--failover-on-shutdown] [--force]
  71                 [--global-max-size &lt;globalMaxSize&gt;] [--home &lt;home&gt;] [--host &lt;host&gt;]
  72                 [--http-host &lt;httpHost&gt;] [--http-port &lt;httpPort&gt;]
  73                 [--java-options &lt;javaOptions&gt;] [--mapped] [--max-hops &lt;maxHops&gt;]
  74                 [--message-load-balancing &lt;messageLoadBalancing&gt;] [--name &lt;name&gt;]
  75                 [--nio] [--no-amqp-acceptor] [--no-autocreate] [--no-autotune]
  76                 [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor]
  77                 [--no-stomp-acceptor] [--no-web] [--paging] [--password &lt;password&gt;]
  78                 [--ping &lt;ping&gt;] [--port-offset &lt;portOffset&gt;] [--queues &lt;queues&gt;]
  79                 [--replicated] [--require-login] [--role &lt;role&gt;] [--shared-store]
  80                 [--silent] [--slave] [--ssl-key &lt;sslKey&gt;]
  81                 [--ssl-key-password &lt;sslKeyPassword&gt;] [--ssl-trust &lt;sslTrust&gt;]
  82                 [--ssl-trust-password &lt;sslTrustPassword&gt;] [--use-client-auth]
  83                 [--user &lt;user&gt;] [--verbose] [--] &lt;directory&gt;
  84      ...
  85 </PRE>
  86
  87
  88 <h2>Starting the Broker</h2>
  89
  90 Once the broker has been created, use the artemis (or artemis.cmd on windows) script found under the bin directory of the newly created broker to manage the life cycle of the broker.
  91
  92 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>
  93
  94 $ ./artemis run<br><br>
  95
  96 To specify a broker configuration file:<br><br>
  97
  98 $ ./artemis run --config scheme:location<br><br>
  99
 100 e.g.<br><br>
 101
 102 $ ./artemis run --config xml:/home/artemis/bootstrap.xml<br><br>
 103
 104 It is possible to configure run time parameters in the artemis.conf (artemis.conf.bat for windows) file under the "bin" directory of the broker directory.
 105
 106 <h2>Stopping the Broker</h2>
 107
 108 To stop the broker please use the artemis script from the broker's bin directory:<br><br>
 109
 110 $ ./artemis stop<br><br>
 111
 112 <h2>Documentation</h2>
 113
 114 The broker comes shipped with an in depth user manual and a bunch of examples to help you get started.  The manual is shipped with the broker and can be accessed from the brokers website.  Start the broker then navigate to the <a href="http://localhost:8161">Apache ActiveMQ Artemis</a>.  Alternatively, you can browse all of the documentation online on the <a href="http://activemq.apache.org/artemis/">Apache ActiveMQ Artemis Website</a>.<br><br>
 115
 116 The examples are shipped inside the distribution folder under "examples"<br><br>
 117
 118 Release Notes for all version can be found <a href="https://issues.apache.org/jira/browse/ARTEMIS/?selectedTab=com.atlassian.jira.jira-projects-plugin:versions-panel">here</a>
 119
 120 </body>