activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [1/2] activemq-artemis git commit: ARTEMIS-903 Add documentation for updating Artemis to newer versions
Date Fri, 06 Jan 2017 01:56:07 GMT
Repository: activemq-artemis
Updated Branches:
  refs/heads/master 574583e0e -> 79647167f

ARTEMIS-903 Add documentation for updating Artemis to newer versions

Currently there is no documentation about updating ActiveMQ Artemis in the Artemis user manual.
This commit adds a brief description of the steps necessary to update Artemis to newer versions.


Branch: refs/heads/master
Commit: 70ac79b7b82e6f0744c8afd6e9051e1756262a6e
Parents: 574583e
Author: Bennet Schulz <>
Authored: Sat Dec 31 14:56:03 2016 +0100
Committer: Clebert Suconic <>
Committed: Thu Jan 5 20:50:15 2017 -0500

 docs/user-manual/en/          |  2 +-
 docs/user-manual/en/ | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/docs/user-manual/en/ b/docs/user-manual/en/
index bf3ed3c..4030aa9 100644
--- a/docs/user-manual/en/
+++ b/docs/user-manual/en/
@@ -61,4 +61,4 @@
 * [Unit Testing](
 * [Troubleshooting and Performance Tuning](
 * [Configuration Reference](
+* [Updating Artemis](
diff --git a/docs/user-manual/en/ b/docs/user-manual/en/
new file mode 100644
index 0000000..9313967
--- /dev/null
+++ b/docs/user-manual/en/
@@ -0,0 +1,25 @@
+# Updating Artemis
+The standard Apache ActiveMQ is runnable out of the box. Just download it, 
+go into the unzipped ActiveMQ folder and run this command: ./bin/activemq run. 
+The ActiveMQ Artemis sub project needs an additional step to run the Message Queue.
+Before running activemq run you have to create a new message broker instance. 
+It looks like an overhead at first glance, but becomes very practically 
+when updating to a new Artemis version for example. 
+To create a artemis broker cd into the artemis folder and run: `./bin/artemis create $HOME/mybroker`
on the command line.
+> **Note**
+> We recommend choosing a folder different than the downloaded apache-artemis one to separate
both from each other.
+> This separation allowes you run multiple brokers with the same artemis runtime for example.

+> It also simplifies updating to newer versions of Artemis.
+Because of this separation it's very easy to update Artemis. 
+You just need to cd into the `etc` folder of your created message broker and open the `artemis.profile`
+It contains a property which is relevant for the update procedure:
+    ARTEMIS_HOME='/Users/.../apache-artemis-X.X.X'
+The `ARTEMIS_HOME` property is used to link the broker together with the Artemis runtime.

+In case you want to update your broker you can simply download the new version of ActiveMQ
Artemis and change the `ARTEMIS_HOME` to the formerly downloaded, newer version.
+That's all. There's no need to touch your broker, copy configuration files or stuff like
\ No newline at end of file

View raw message