org.jboss.hal.resources.previews.management.extensions.html Maven / Gradle / Ivy
Extensions are a way to add new features to the management console. They are written in JavaScript and should use the
JavaScript API to interact with the console and the management interface. If you want to develop an extension, see
https://github.com/hal/hal.next/wiki/Extensions for more information.
Extensions are written in JavaScript and are
injected into the browser. Please install only extensions that you trust!
Extension Points
The console provides four different extension points which can be used by extensions:
- Header: Adds a menu item to the "Extensions" dropdown in the header
- Finder Item: Adds a new item to a specific finder column
- Footer: Adds a menu item to the "Extensions" dropdown in the footer
- Custom: It's up to the extension how to add itself to the console
Installation
Extensions can be added to the console using two different ways:
- Bundled Extensions
-
Bundled extensions are part of the ${build.fullName} installation and installed as modules. They have to be installed outside of the console. WildFly and the console have to be restarted / reloaded after adding or removing bundled extensions.
- Standalone Extensions
-
Standalone extensions are hosted by a public available endpoint. This endpoint must serve a JSON file which contains metadata for the extension. You can add and remove standalone extensions using the management console. They're stored in the browser's local storage. As such they're scoped to the browser and URL which runs the management console.