Skip to content

Commit

Permalink
Upgrade docs to latest release
Browse files Browse the repository at this point in the history
  • Loading branch information
davsclaus committed Mar 9, 2016
1 parent 31fa759 commit cbd4371
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
28 changes: 14 additions & 14 deletions docs/GetStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ The out of the box defaults try to do the right thing for most folks but if you

You can startup hawtio on your machine using the hawtio-app executable jar.

<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-app/1.4.61/hawtio-app-1.4.61.jar">Download the executable hawtio-app-1.4.61.jar</a>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-app/1.4.62/hawtio-app-1.4.62.jar">Download the executable hawtio-app-1.4.62.jar</a>

Once you have downloaded it, just run this from the command line:

java -jar hawtio-app-1.4.61.jar
java -jar hawtio-app-1.4.62.jar

And the console should show you which URL to open to view hawtio; which by default is [http://localhost:8080/hawtio/](http://localhost:8080/hawtio/)

You can specify the port number to use, for example to use port 8090 run from the command line:

java -jar hawtio-app-1.4.61.jar --port 8090
java -jar hawtio-app-1.4.62.jar --port 8090

hawtio supports other options which you can get listed by running from command line:

java -jar hawtio-app-1.4.61.jar --help
java -jar hawtio-app-1.4.62.jar --help

<a name="web-container"></a>
## Using a Servlet Engine or Application Server
Expand All @@ -38,15 +38,15 @@ If you are running Tomcat 5/6/7, Jetty 7/8 or you could just deploy a WAR:
<div class="row">
<div class="col-md-6 span6 text-center">
<p>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default/1.4.61/hawtio-default-1.4.61.war">Download hawtio-default.war</a>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default/1.4.62/hawtio-default-1.4.62.war">Download hawtio-default.war</a>
</p>
<p>
a bare hawtio web application with minimal dependencies
</p>
</div>
<div class="col-md-6 span6 text-center">
<p>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/sample/1.4.61/sample-1.4.61.war">Download sample.war</a>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/sample/1.4.62/sample-1.4.62.war">Download sample.war</a>
</p>
<p>
a hawtio web application which comes with some <a href="http://activemq.apache.org/">Apache ActiveMQ</a> and
Expand All @@ -59,12 +59,12 @@ Copy the WAR file to your deploy directory in your container.

If you rename the downloaded file to _hawtio.war_ then drop it into your deploy directory then open [http://localhost:8080/hawtio/](http://localhost:8080/hawtio/) and you should have your hawtio console to play with.

Otherwise you will need to use either [http://localhost:8080/hawtio-default-1.4.61/](http://localhost:8080/hawtio-default-1.4.61/) or [http://localhost:8080/sample-1.4.61/](http://localhost:8080/sample-1.4.61/) depending on the file name you downloaded.
Otherwise you will need to use either [http://localhost:8080/hawtio-default-1.4.62/](http://localhost:8080/hawtio-default-1.4.62/) or [http://localhost:8080/sample-1.4.62/](http://localhost:8080/sample-1.4.62/) depending on the file name you downloaded.

Please check [the configuration guide](http://hawt.io/configuration/index.html) to see how to configure things; in particular security.

If you are working offline and have no access to the internet on the machines you want to use with hawtio then you may wish to
<a class="btn btn-default" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default-offline/1.4.61/hawtio-default-offline-1.4.61.war">Download hawtio-default-offline.war</a> which avoids some pesky errors appearing in your log on startup (as the default behaviour is to clone a git repo on startup for some default wiki and dashboard content).
<a class="btn btn-default" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default-offline/1.4.62/hawtio-default-offline-1.4.62.war">Download hawtio-default-offline.war</a> which avoids some pesky errors appearing in your log on startup (as the default behaviour is to clone a git repo on startup for some default wiki and dashboard content).

If you don't see a Tomcat / Jetty tab for your container you may need to enable JMX.

Expand All @@ -75,24 +75,24 @@ If you are using 6.1 or later of [JBoss Fuse](http://www.jboss.org/products/fuse

Otherwise if you are using 6.0 or earlier of [Fuse](http://www.jboss.org/products/fuse) or a vanilla [Apache Karaf](http://karaf.apache.org/) or [Apache ServiceMix](http://servicemix.apache.org/) then try the following:

features:addurl mvn:io.hawt/hawtio-karaf/1.4.61/xml/features
features:addurl mvn:io.hawt/hawtio-karaf/1.4.62/xml/features
features:install hawtio

If you are using [Apache Karaf](http://karaf.apache.org/) 2.x then you can use 'features:chooseurl' which is simpler to do:

features:chooseurl hawtio 1.4.61
features:chooseurl hawtio 1.4.62
features:install hawtio

The hawtio console can then be viewed at [http://localhost:8181/hawtio/](http://localhost:8181/hawtio/). The default login for Karaf is karaf/karaf, and for ServiceMix its smx/smx.

If you are using [Apache Karaf](http://karaf.apache.org/) 3.x or newer then you can use 'feature:repo-add' which is simpler to do, and install hawtio-core:

feature:repo-add hawtio 1.4.61
feature:repo-add hawtio 1.4.62
feature:install hawtio-core

**NOTE** if you are on ServiceMix 4.5 or newer then you should install hawtio-core instead of hawtio, eg

features:addurl mvn:io.hawt/hawtio-karaf/1.4.61/xml/features
features:addurl mvn:io.hawt/hawtio-karaf/1.4.62/xml/features
features:install hawtio-core

**NOTE** Karaf 3.x/4.x has an issue with the hawtio-terminal which does not yet work. And therefore you need to install hawtio-core instead of hawtio.
Expand Down Expand Up @@ -122,7 +122,7 @@ The following section gives details of other containers
<a name="jee"></a>
### If you use JBoss AS or Wildfly

You may have issues with slf4j JARs in WAR deployments on JBoss AS or Wildfly. To resolve this you must use <a class="btn-default" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-no-slf4j/1.4.61/hawtio-no-slf4j-1.4.61.war">Download hawtio-no-slf4j.war</a>.
You may have issues with slf4j JARs in WAR deployments on JBoss AS or Wildfly. To resolve this you must use <a class="btn-default" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-no-slf4j/1.4.62/hawtio-no-slf4j-1.4.62.war">Download hawtio-no-slf4j.war</a>.

See more details [here](http://totalprogus.blogspot.co.uk/2011/06/javalanglinkageerror-loader-constraint.html).

Expand Down Expand Up @@ -211,7 +211,7 @@ If you wish to do anything fancy it should be easy to override the Main class to

> Chrome Extension currently does not work, as Google requires extensions to be installed using their app store, and hawtio are not yet published to the app store. This may change in the future.
<a class="btn btn-large btn-primary" href="http://central.maven.org/maven2/io/hawt/hawtio-crx/1.4.61/hawtio-crx-1.4.61.crx">Download the hawtio Chrome Extension version 1.4.61</a>
<a class="btn btn-large btn-primary" href="http://central.maven.org/maven2/io/hawt/hawtio-crx/1.4.62/hawtio-crx-1.4.62.crx">Download the hawtio Chrome Extension version 1.4.62</a>

* Then you'll need to open the folder that the CRX file got downloaded to. On a Mac in Chrome you right click the downloaded file and click <b>Show in Finder</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/HowPluginsWork.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Currently hawtio uses JMX to discover which MBeans are present and then dynamically updates the navigation bars and tabs based on what it finds. The UI is updated whenever hawtio reloads the mbeans JSON; which it does periodically or a plugin can trigger explicitly.

So you can deploy the standard [hawtio-web.war](https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-web/1.4.61/hawtio-web-1.4.61.war); then as you deploy more services to your container, hawtio will update itself to reflect the suitable plugins in the UI.
So you can deploy the standard [hawtio-web.war](https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-web/1.4.62/hawtio-web-1.4.62.war); then as you deploy more services to your container, hawtio will update itself to reflect the suitable plugins in the UI.

Relying on JMX for discovery doesn't mean though that plugins can only interact with JMX; they can do anything at all that a browser can. e.g. a plugin could use REST to discover UI capabilities and other plugins.

Expand Down Expand Up @@ -57,7 +57,7 @@ For example the current directory is `myfolder`, where we create a sub directory
myfolder$
mkdir plugins
cp ~/mycustomplugin.war plugins
java -jar hawtio-app-1.4.61.jar
java -jar hawtio-app-1.4.62.jar

You can copy as many custom plugins to the `plugins` directory.

Expand Down
8 changes: 4 additions & 4 deletions docs/MavenPlugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ In the Maven pom.xml file, the **hawtio** plugin is configured by adding the fol
<plugin>
<groupId>io.hawt</groupId>
<artifactId>hawtio-maven-plugin</artifactId>
<version>1.4.61</version>
<version>1.4.62</version>
<configuration>
<!-- configuration options goes here -->
</configuration>
Expand Down Expand Up @@ -290,9 +290,9 @@ To run the same example with **hawtio** embedded as a web console, you simply do
cd examples
cd camel-example-console
mvn compile
mvn io.hawt:hawtio-maven-plugin:1.4.61:camel
mvn io.hawt:hawtio-maven-plugin:1.4.62:camel

Where 1.4.61 is the **hawtio** version to use.
Where 1.4.62 is the **hawtio** version to use.

### Adding hawtio plugin to the Apache Camel examples

Expand All @@ -303,7 +303,7 @@ In the &lt;build&gt;&lt;plugin&gt;section add the following xml code:
<plugin>
<groupId>io.hawt</groupId>
<artifactId>hawtio-maven-plugin</artifactId>
<version>1.4.61</version>
<version>1.4.62</version>
</plugin>

And you can run the console example simply by typing
Expand Down
2 changes: 1 addition & 1 deletion docs/Plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ For more details see the [Configuration Guide](http://hawt.io/configuration/inde

## Included Plugins

The following plugins are all included by default in the [hawtio-web.war](https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-web/1.4.61/hawtio-web-1.4.61.war) distro. You can see the [source for the all default plugins here](https://github.com/hawtio/hawtio/tree/master/hawtio-web/src/main/webapp/app).
The following plugins are all included by default in the [hawtio-web.war](https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-web/1.4.62/hawtio-web-1.4.62.war) distro. You can see the [source for the all default plugins here](https://github.com/hawtio/hawtio/tree/master/hawtio-web/src/main/webapp/app).


<table class="table">
Expand Down

0 comments on commit cbd4371

Please sign in to comment.