Skip to content

Commit

Permalink
updated docs to the new 1.2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jstrachan committed Nov 20, 2013
1 parent edb2ce1 commit fe015cd
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions BUILDING.md
Expand Up @@ -111,10 +111,10 @@ To specify a different port to run on, just override the `jettyPort` property

The easiest way to use other containers and still get the benefits of LiveReload is to create a symbolic link to the generated hawtio-web war in expanded form, in the deploy directory in your web server.

e.g. to use Tomcat7 in LiveReload mode try the following to create a symbolic link in the tomcat/webapps directory to the **hawtio-web/target/hawtio-web-1.2-SNAPSHOT** directory:
e.g. to use Tomcat7 in LiveReload mode try the following to create a symbolic link in the tomcat/webapps directory to the **hawtio-web/target/hawtio-web-1.3-SNAPSHOT** directory:

cd tomcat/webapps
ln -s ~/hawtio/hawtio-web/target/hawtio-web-1.2-SNAPSHOT hawtio
ln -s ~/hawtio/hawtio-web/target/hawtio-web-1.3-SNAPSHOT hawtio

Then in a shell run

Expand All @@ -128,11 +128,11 @@ Now just run Tomcat as normal. You should have full LiveReload support and shoul
For jetty you need to name the symlink directory **hawtio.war** for [Jetty to recognise it](http://www.eclipse.org/jetty/documentation/current/automatic-webapp-deployment.html).

cd jetty-distribution/webapps
ln -s ~/hawtio/hawtio-web/target/hawtio-web-1.2-SNAPSHOT hawtio.war
ln -s ~/hawtio/hawtio-web/target/hawtio-web-1.3-SNAPSHOT hawtio.war

Another thing is for symlinks jetty uses the real directory name rather than the symlink name for the context path.

So to open the application in Jetty open [http://localhost:8080/hawtio-web-1.2-SNAPSHOT/](http://localhost:8080/hawtio-web-1.2-SNAPSHOT/)
So to open the application in Jetty open [http://localhost:8080/hawtio-web-1.3-SNAPSHOT/](http://localhost:8080/hawtio-web-1.3-SNAPSHOT/)


## Running Unit Tests
Expand Down
2 changes: 1 addition & 1 deletion CHANGES.md
@@ -1,6 +1,6 @@
### Change Log

#### 1.2
#### 1.2.0

* Connectivity
* New _JVMs_ tab lets you connect to remote JVMs on your local machine; which if a JVM does not have jolokia installed it will install it on the fly. (Requires tools.jar in the classpath)
Expand Down
2 changes: 1 addition & 1 deletion doc/Configuration.md
Expand Up @@ -57,7 +57,7 @@ this will disable security login. (Or use a different property to change the def

Or if you are running hawtio stand alone try:

java -Dhawtio.authenticationEnabled=false -jar ~/Downloads/hawtio-app-1.2-M27.jar
java -Dhawtio.authenticationEnabled=false -jar ~/Downloads/hawtio-app-1.2.0.jar

If you are using containers like Tomcat you can pass in system property values via the **CATALINA_OPTS** environment variable instead.

Expand Down
22 changes: 11 additions & 11 deletions doc/GetStarted.md
Expand Up @@ -7,21 +7,21 @@ The out of the box defaults try to do the right thing for most folks but you may

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.2-M27/hawtio-app-1.2-M27.jar">Download the executable hawtio-app-1.2-M27.jar</a>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-app/1.2.0/hawtio-app-1.2.0.jar">Download the executable hawtio-app-1.2.0.jar</a>

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

java -jar hawtio-app-1.2-M27.jar
java -jar hawtio-app-1.2.0.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.2-M27.jar --port 8090
java -jar hawtio-app-1.2.0.jar --port 8090

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

java -jar hawtio-app-1.2-M27.jar --help
java -jar hawtio-app-1.2.0.jar --help

## Using a Servlet Engine or Application Server

Expand All @@ -30,10 +30,10 @@ If you are running Tomcat 5/6/7, Jetty 7/8 or JBoss (7.1.1.Final) you could just
<table class="buttonTable">
<tr>
<td>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default/1.2-M27/hawtio-default-1.2-M27.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.2.0/hawtio-default-1.2.0.war">Download hawtio-default.war</a>
</td>
<td>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/sample/1.2-M27/sample-1.2-M27.war">Download sample.war</a>
<a class="btn btn-large btn-primary" href="https://oss.sonatype.org/content/repositories/public/io/hawt/sample/1.2.0/sample-1.2.0.war">Download sample.war</a>
</td>
</tr>
<tr>
Expand All @@ -51,12 +51,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.2-M27/](http://localhost:8080/hawtio-default-1.2-M27/) or [http://localhost:8080/sample-1.2-M27/](http://localhost:8080/sample-1.2-M27/) depending on the file name you downloaded.
Otherwise you will need to use either [http://localhost:8080/hawtio-default-1.2.0/](http://localhost:8080/hawtio-default-1.2.0/) or [http://localhost:8080/sample-1.2.0/](http://localhost:8080/sample-1.2.0/) 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" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default-offline/1.2-M27/hawtio-default-offline-1.2-M27.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" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-default-offline/1.2.0/hawtio-default-offline-1.2.0.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).

To see whats changed lately check out the [change log](http://hawt.io/changelog.html).

Expand All @@ -68,7 +68,7 @@ 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.2-M27/xml/features
features:addurl mvn:io.hawt/hawtio-karaf/1.2.0/xml/features
features:install hawtio

If you are using [Apache Karaf](http://karaf.apache.org/) 2.3.3 or newer then you can use 'features:chooseurl' which is simpler to do:
Expand All @@ -80,7 +80,7 @@ The hawtio console can then be viewed at [http://localhost:8181/hawtio/](http://

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

features:addurl mvn:io.hawt/hawtio-karaf/1.2-M27/xml/features
features:addurl mvn:io.hawt/hawtio-karaf/1.2.0/xml/features
features:install hawtio-core

### If you use a HTTP proxy
Expand Down Expand Up @@ -115,7 +115,7 @@ If you are using Jetty 8.x then JMX may not enabled by default, so make sure the

If you use JBoss AS 7.x or later or use EAP 6.x or later the above should just work.

However for JBoss AS 6.x or earlier there is [an issue with using newer versions of slf4j](http://totalprogus.blogspot.co.uk/2011/06/javalanglinkageerror-loader-constraint.html) so you must use <a class="btn" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-no-slf4j/1.2-M27/hawtio-no-slf4j-1.2-M27.war">Download hawtio-no-slf4j.war</a>.
However for JBoss AS 6.x or earlier there is [an issue with using newer versions of slf4j](http://totalprogus.blogspot.co.uk/2011/06/javalanglinkageerror-loader-constraint.html) so you must use <a class="btn" href="https://oss.sonatype.org/content/repositories/public/io/hawt/hawtio-no-slf4j/1.2.0/hawtio-no-slf4j-1.2.0.war">Download hawtio-no-slf4j.war</a>.

To disable security [configure the system properties](http://www.mastertheboss.com/jboss-configuration/how-to-inject-system-properties-into-jboss) by adding the following to your **jboss-as/server/default/deploy/properties-service.xml** file (which probably has the mbean definition already but commented out):

Expand Down
2 changes: 1 addition & 1 deletion doc/HowPluginsWork.md
@@ -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.2-M27/hawtio-web-1.2-M27.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.2.0/hawtio-web-1.2.0.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
2 changes: 1 addition & 1 deletion doc/Plugins.md
Expand Up @@ -6,7 +6,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.2-M27/hawtio-web-1.2-M27.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.2.0/hawtio-web-1.2.0.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
2 changes: 1 addition & 1 deletion hawtio-plugin-examples/custom-perspective/readme.md
Expand Up @@ -64,7 +64,7 @@ The "lastPage" attribute is how the perspective plugin keeps track of the last t
The plugin does still define an Import-Package so it can be deployed into Apache Karaf by dropping it into the "deploy" directory or doing something like:

```
osgi:install -s mvn:io.hawt/custom-perspective/1.2-SNAPSHOT/war
osgi:install -s mvn:io.hawt/custom-perspective/1.3-SNAPSHOT/war
```

For other app servers you may need to add whatever app server specific configuration is necessary to get the plugin's context root to be /hawtio/custom-perspective, otherwise you'll need to edit PluginContextListener.java to specify the context the plugin is at and rebuild so that hawtio can find the plugin's javascript file.
Expand Down
4 changes: 2 additions & 2 deletions website/ext/Website.scala
Expand Up @@ -29,8 +29,8 @@ object Website {
val project_forums_url= "http://hawt.io/community/index.html"
val project_wiki_url= "https://github.com/hawtio/hawtio/wiki"
val project_logo= "/images/project-logo.png"
val project_version= "1.2-M6"
val project_snapshot_version= "1.2-SNAPSHOT"
val project_version= "1.2.0"
val project_snapshot_version= "1.3-SNAPSHOT"
val project_versions = List(
project_version
)
Expand Down

0 comments on commit fe015cd

Please sign in to comment.