You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ch...@apache.org on 2011/06/02 18:37:47 UTC

svn commit: r1130642 - in /activemq/activemq-apollo/trunk: apollo-boot/src/test/ apollo-boot/src/test/ide-resources/ apollo-web/ apollo-website/src/documentation/

Author: chirino
Date: Thu Jun  2 16:37:47 2011
New Revision: 1130642

URL: http://svn.apache.org/viewvc?rev=1130642&view=rev
Log:
Added more details about the unix service, and how to install as a service on windows.

Added:
    activemq/activemq-apollo/trunk/apollo-boot/src/test/
    activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/
    activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/log4j.properties   (with props)
    activemq/activemq-apollo/trunk/apollo-web/JoSQL-2.2.jar
    activemq/activemq-apollo/trunk/apollo-web/P$.class
    activemq/activemq-apollo/trunk/apollo-web/P.class
    activemq/activemq-apollo/trunk/apollo-web/Test$.class
    activemq/activemq-apollo/trunk/apollo-web/Test$P$2.class
    activemq/activemq-apollo/trunk/apollo-web/Test$P$3$.class
    activemq/activemq-apollo/trunk/apollo-web/Test.class
    activemq/activemq-apollo/trunk/apollo-web/gentlyWEB-utils-1.1.jar
Modified:
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md

Added: activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/log4j.properties
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/log4j.properties?rev=1130642&view=auto
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/log4j.properties (added)
+++ activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/log4j.properties Thu Jun  2 16:37:47 2011
@@ -0,0 +1,35 @@
+## ---------------------------------------------------------------------------
+## 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.
+## ---------------------------------------------------------------------------
+
+#
+# The logging properties used during tests..
+#
+log4j.rootLogger=WARN, console, file
+log4j.logger.org.apache.activemq=TRACE
+
+# Console will only display warnnings
+log4j.appender.console=org.apache.log4j.ConsoleAppender
+log4j.appender.console.layout=org.apache.log4j.PatternLayout
+log4j.appender.console.layout.ConversionPattern=%-5p | %t | %m%n
+log4j.appender.console.threshold=TRACE
+
+# File appender will contain all info messages
+log4j.appender.file=org.apache.log4j.FileAppender
+log4j.appender.file.layout=org.apache.log4j.PatternLayout
+log4j.appender.file.layout.ConversionPattern=%d | %-5p | %m | %c | %t%n
+log4j.appender.file.file=target/test.log
+log4j.appender.file.append=true

Propchange: activemq/activemq-apollo/trunk/apollo-boot/src/test/ide-resources/log4j.properties
------------------------------------------------------------------------------
    svn:executable = *

Added: activemq/activemq-apollo/trunk/apollo-web/JoSQL-2.2.jar
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/JoSQL-2.2.jar?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/JoSQL-2.2.jar (added) and activemq/activemq-apollo/trunk/apollo-web/JoSQL-2.2.jar Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/P$.class
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/P%24.class?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/P$.class (added) and activemq/activemq-apollo/trunk/apollo-web/P$.class Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/P.class
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/P.class?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/P.class (added) and activemq/activemq-apollo/trunk/apollo-web/P.class Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/Test$.class
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/Test%24.class?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/Test$.class (added) and activemq/activemq-apollo/trunk/apollo-web/Test$.class Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/Test$P$2.class
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/Test%24P%242.class?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/Test$P$2.class (added) and activemq/activemq-apollo/trunk/apollo-web/Test$P$2.class Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/Test$P$3$.class
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/Test%24P%243%24.class?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/Test$P$3$.class (added) and activemq/activemq-apollo/trunk/apollo-web/Test$P$3$.class Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/Test.class
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/Test.class?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/Test.class (added) and activemq/activemq-apollo/trunk/apollo-web/Test.class Thu Jun  2 16:37:47 2011 differ

Added: activemq/activemq-apollo/trunk/apollo-web/gentlyWEB-utils-1.1.jar
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-web/gentlyWEB-utils-1.1.jar?rev=1130642&view=auto
==============================================================================
Files activemq/activemq-apollo/trunk/apollo-web/gentlyWEB-utils-1.1.jar (added) and activemq/activemq-apollo/trunk/apollo-web/gentlyWEB-utils-1.1.jar Thu Jun  2 16:37:47 2011 differ

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md?rev=1130642&r1=1130641&r2=1130642&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md Thu Jun  2 16:37:47 2011
@@ -764,7 +764,8 @@ A `web_admin` element may be configured 
 ## Managing Brokers
 
 The rest of this section's example assume that you have created a broker 
-instance under the `/var/lib/mybroker` directory.
+instance under the `/var/lib/mybroker` directory or `c:\mybroker` directory
+if your on windows.
 
 ### Running a Broker Instance in the Foreground
 
@@ -778,19 +779,41 @@ to the process.
 
 ### Managing a Background Broker Instance
 
-If you are on Unix, you can use `bin/apollo-broker-service` script
-to start the broker in the background.  Example:
+#### On Linux/Unix
 
-    /var/lib/mybroker/bin/apollo-broker-service start
+If you are on Unix, you can use the `bin/apollo-broker-service` script
+to manage the broker service.  This script is compatible with the
+`/etc/init.d` style scripts most Unix/Linux systems use to control
+background services.
 
-You can use the same script to check to see  if the broker is still 
-running.  Example:
+On a Ubuntu OS, you install the service and have it run on start 
+up by running:
 
-    /var/lib/mybroker/bin/apollo-broker-service status
-    
-You can stop the background broker by running:
+    sudo ln -s /var/lib/mybroker/bin/apollo-broker-service /etc/init.d/apollo
+    sudo update-rc.d apollo defaults
+
+On a Redhat OS, you install the service and have it run on start 
+up by running:
+
+    sudo ln -s /var/lib/mybroker/bin/apollo-broker-service /etc/init.d/apollo
+    sudo chkconfig apollo --add
+
+On other Unixes, you install the service and have it run on start 
+up by running:
 
-    /var/lib/mybroker/bin/apollo-broker-service stop
+    sudo ln -s /var/lib/mybroker/bin/apollo-broker-service /etc/init.d/apollo
+    sudo ln -s /etc/init.d/apollo /etc/rc0.d/K80apollo
+    sudo ln -s /etc/init.d/apollo /etc/rc1.d/K80apollo
+    sudo ln -s /etc/init.d/apollo /etc/rc3.d/S20apollo
+    sudo ln -s /etc/init.d/apollo /etc/rc5.d/S20apollo
+    sudo ln -s /etc/init.d/apollo /etc/rc6.d/K80apollo
+
+You can directly use the script to perform the following functions:
+
+* starting: `apollo-broker-service start`
+* stopping: `apollo-broker-service stop`
+* restarting: `apollo-broker-service restart`
+* checking the status: `apollo-broker-service status`
 
 When the broker is started in the background, it creates
 a `data/apollo.pid` file which contains the process id of
@@ -798,11 +821,38 @@ the process executing the broker.  This 
 used to integrated with external watch dog process
 such as [Monit](http://mmonit.com/monit/).
 
+#### On Windows
+
+Windows users can install the broker as background service using the
+`bin\apollo-broker-service` executable.
+
+To install as a background service you would execute:
+
+    c:\mybroker\bin\apollo-broker-service install
+
+Uninstalling the service is done using:
+
+    c:\mybroker\bin\apollo-broker-service uninstall
+    
+You can now use the standard Windows service tools to control
+starting and stopping the broker or you can also use the
+same executable to:
+
+* start the service: `apollo-broker-service start`
+* stop the service: `apollo-broker-service stop`
+* check the status: `apollo-broker-service restart`
+
+If you want to customize the JVM options use to start the background
+service, you will need to edit the `bin\apollo-broker-service.xml`
+file.  All service console and event logging perform by the background
+service are stored under `log\apollo-broker-service.*`.
+
 ### Viewing Broker State
 
 ${project_name} provides a web based interface for administrators to inspect
 the runtime state of the Broker.  If your running the broker on your local
-machine, just open your web browser to [`http://localhost:61680`](http://localhost:61680).
+machine, just open your web browser to [`http://localhost:61680`](http://localhost:61680)
+or [`https://localhost:61681`](httsp://localhost:61681).
 
 The web interface will display the status of the the connectors and show
 attached connections.  It will also allow you to drill into each configured