Apache ActiveMQ Artemis README

# Getting Started

Note (Windows users): The broker currently does not support spaces in path names. For this reason the broker should be placed in a directory with no spaces in it's absolute path. Note (Windows users): Examples below use the shell script `artemis` for use with linux, Windows users should use the `artemis.cmd` script with the same parameters.

## Creating a broker

To create a broker, navigate to the distribution 'bin/' directory and run: $ ./artemis create $directory Where $directory is the folder that you'd like the broker to be created. The create process will input for any required property not specified. Example:

    --user: is mandatory with this configuration:
    Please provide the default username:
    admin

    --password: is mandatory with this configuration:
    Please provide the default password:

    --allow-anonymous: is mandatory with this configuration:
    Allow anonymous access? (Y/N):
    y

For a full list of available options for the create process you may use: $ ./artemis help create

    NAME
            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>
         ...

## Starting the Broker

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. To run the Apache ActiveMQ Artemis broker with the default configuration, run the command shown below from the "bin" directory of the created broker. $ ./artemis run To specify a broker configuration file: $ ./artemis run --config scheme:location e.g. $ ./artemis run --config xml:/home/artemis/bootstrap.xml It is possible to configure run time paramters in the artemis.conf (artemis.conf.bat for windows) file under the "bin" directory of the broker directory.

## Stopping the Broker

To stop the broker please use the artemis script from the broker's bin directory: $ ./artemis stop

## Documentation

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 Apache ActiveMQ Artemis. Alternatively, you can browse all of the documentation online on the Apache ActiveMQ Artemis Website. The examples are shipped inside the distribution folder under "examples"

## Release Notes - Apache ActiveMQ Artemis 1.1.0

A complete list of JIRAs for the 1.1.0 release can be found at the Apache ActiveMQ Artemis project JIRA

Overall Apache ActiveMQ Artemis 1.1.0 has several improvements and it's a nice polish on top of Apache ActiveMQ Artemis 1.0.0, things like better examples, better OpenWire support and the first release of MQTT.

We would like to highlight the following accomplishments on this release:

- [ARTEMIS-154] This is our first implementation of the MQTT support.

- ARTEMIS-178 The examples are now using the CLI to create and start servers reflecting real cases used in production. The documentation about the examples has been updated. Please refer to the documentation for more information about this.

- [ARTEMIS-116] The CLI has been improved. There are new tools to compact the journal and we did a lot of polish around the CLI.

- Improvements on OpenWire We fixed several issues around OpenWire

### Where we are still improving.

1.1.0 has improved a lot, and these are the areas we are still working on:

- This is the first release with MQTT. We would like to hear from you if you have any issues around MQTT as we are continuously improving the MQTT support

- Short list of what need to be implemented on OpenWire for future releases:
  - Reconnection
  - Better Flow Control on producers
  - Compressed messages
  - Optimized ACKs
  - Streamlet support

## Release Notes - ActiveMQ Artemis 1.0.0

The ActiveMQ Artemis 1.0.0 release notes can be found in the Apache ActiveMQ Artemis project JIRA.