activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chir...@apache.org
Subject svn commit: r1031544 - in /activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation: getting-started.md module-organization.page
Date Fri, 05 Nov 2010 12:50:42 GMT
Author: chirino
Date: Fri Nov  5 12:50:41 2010
New Revision: 1031544

URL: http://svn.apache.org/viewvc?rev=1031544&view=rev
Log:
added a getting started guide.

Added:
    activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/getting-started.md
Modified:
    activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/module-organization.page

Added: activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/getting-started.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/getting-started.md?rev=1031544&view=auto
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/getting-started.md
(added)
+++ activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/getting-started.md
Fri Nov  5 12:50:41 2010
@@ -0,0 +1,127 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+  
+       http://www.apache.org/licenses/LICENSE-2.0
+  
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  Architecture
+-->
+# Getting Started Guide
+
+This guide will help you install, setup and run an Apollo broker and validate it
+is operating correctly.
+
+## Installation
+
+1. [Download](../download.html) the ${project_name} distribution that is 
+   most appropriate for your operating system.
+
+2. Extract the distribution archive:
+   {pygmentize_and_compare::wide=true}
+-----------------------------
+text: Unix/Linux/OS X
+-----------------------------
+tar -zxvf apache-apollo-${project_version}-unix-distro.tar.gz
+-----------------------------
+text: Windows
+-----------------------------
+jar -xvf apache-apollo-${project_version}-windows-distro.zip
+{pygmentize_and_compare}
+
+3. Set your shell's `APOLLO_HOME` environment variable to
+   where the extracted `apache-apollo-${project_version}` directory 
+   is located.
+   
+4. Add the extracted `apache-apollo-${project_version}/bin` directory
+   to your shell's `PATH` environment variable.
+
+## Creating a Broker Instance
+
+A broker instance is the directory containing all the configuration and runtime
+data such as logs and data files associated with a broker process.  It is recommended that
+you do *not* create the instance directory under the directory where the ${project_name}

+distribution is installed.
+
+On unix systems, it is a common convention to store this kind of runtime data under 
+the `/var/lib` directory.  For example, to create an instance at '/var/lib/mybroker', run:
+
+    cd /var/lib
+    apollo create mybroker
+
+A broker instance directory will contain the following sub directories:
+
+ * `bin`: holds execution scripts associated with this instance.
+ * `etc`; hold the instance configuration files
+ * `data`: holds the data files used for storing persistent messages
+ * `log`: holds rotating log files
+ * `tmp`: holds temporary files that are safe to delete between broker runs
+
+At this point you may want to adjust the default configuration located in
+etc directory.
+
+## Running a Broker Instance
+
+Assuming you created the broker instance under `/var/lib/mybroker` all you need
+to do start running the broker instance is execute:
+
+    /var/lib/mybroker/bin/apollo-broker run
+
+## Verification
+
+You can use the ruby examples included in the distribution to verify that the 
+broker is operating correctly.
+
+If you have not already done so, install the `stomp` Ruby gem.
+
+    gem install stomp
+
+Change to the `examples/ruby` directory that was included in the ${project_name} 
+distribution.  Then in a terminal window, run:
+
+{pygmentize_and_compare::}
+-----------------------------
+text: Unix/Linux/OS X
+-----------------------------
+cd ${APOLLO_HOME}/examples/ruby
+ruby listener.rb
+-----------------------------
+text: Windows
+-----------------------------
+cd %APOLLO_HOME%\examples\ruby
+ruby listener.rb
+{pygmentize_and_compare}
+
+Then in a separate terminal window, run:
+{pygmentize_and_compare::}
+-----------------------------
+text: Unix/Linux/OS X
+-----------------------------
+cd ${APOLLO_HOME}/examples/ruby
+ruby publisher.rb
+-----------------------------
+text: Windows
+-----------------------------
+cd %APOLLO_HOME%\examples\ruby
+ruby publisher.rb
+{pygmentize_and_compare}
+
+If everything is working well, the publisher should produce output similar to:
+
+    Sent 1000 messages
+    Sent 1000 messages
+    ...
+
+The consumer's output should look like:
+    
+    Received 1000 messages.
+    Received 2000 messages.
+    ...

Modified: activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/module-organization.page
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/module-organization.page?rev=1031544&r1=1031543&r2=1031544&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/module-organization.page
(original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/main/webapp/documentation/module-organization.page
Fri Nov  5 12:50:41 2010
@@ -39,6 +39,7 @@ You can regenerate the above graph by ru
 project root:
 
     mvn -P graph graph:reactor -Dhide-transitive=true -Dhide-external=true -Dgraph.label=
-Dhide-version=true -Dhide-group-id=true -Dhide-type=true
-    cp target/reactor-graph.png apollo-website/src/images/module-deps-graph.png
+    cp target/reactor-graph.png apollo-website/src/main/webapp/images/module-deps-graph.png

+
 
 



Mime
View raw message