Skip to content

Commit

Permalink
docs: highlight popular plugins in overview
Browse files Browse the repository at this point in the history
  • Loading branch information
tadayosi committed Dec 21, 2023
1 parent a42f67e commit 89f0223
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
16 changes: 14 additions & 2 deletions modules/ROOT/pages/overview-v3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,32 @@ V3 is a complete reimplementation of Hawtio console UI with https://react.dev/[R

image::hawtio-console.png[width=80%]

== Plugins

:fn-artemis-plugin: footnote:[Artemis plugin is provided only with the Artemis broker management console. It is developed by the Artemis project.]

One of Hawtio's defining features is its plugin architecture. In addition to the essential JMX functionality, the highly popular https://camel.apache.org/[Apache Camel] and https://activemq.apache.org/components/artemis/[Apache ActiveMQ Artemis] {fn-artemis-plugin} plugins are provided from the outset.

If you don't find a plugin you want to use, you can easily extend the plugin yourself.

See xref:plugins.adoc[] for more information on the available plugins and how you can develop your own plugin.

== The projects

Hawtio v3 is composed of the following projects:

* Hawtio React NPM package
* Hawtio (Standalone)

== Hawtio React
=== Hawtio React

Repository:: https://github.com/hawtio/hawtio-next

This NPM project is the frontend UI part of the Hawtio console. It is implemented with React and PatternFly, and published to the NPM registry as https://www.npmjs.com/package/@hawtio/react[@hawtio/react].

The xref:plugins.adoc[built-in plugins] are hosted in the project.

== Hawtio (Standalone)
=== Hawtio (Standalone)

Repository:: https://github.com/hawtio/hawtio

Expand Down
6 changes: 6 additions & 0 deletions modules/ROOT/pages/plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ a|Shows information about the Spring Boot application.
Requirements:: Requires Spring Boot https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.endpoints[Health, Info, Loggers, and HTTP Exchanges endpoints] to be exposed to activate each corresponding tab in the plugin.
|===

== Known external plugins

The following plugins are developed by external communities.

Apache ActiveMQ Artemis plugin:: https://activemq.apache.org/components/artemis/[Apache ActiveMQ Artemis] ships with its own web management console, which is built on top of Hawtio with an external plugin that provides the dedicated view for Artemis brokers. You can navigate the acceptors and addresses through the console and operate on them. See https://activemq.apache.org/components/artemis/documentation/latest/management-console.html#management-console[Artemis User Manual - Management Console] for more information.

== Custom plugins

You can also extend the Hawtio capabilities by developing a custom plugin.
Expand Down

0 comments on commit 89f0223

Please sign in to comment.