Documentation

Author: hpehl

.github/workflows/container.yml

@@ -7,7 +7,7 @@ permissions:
   contents: write
 
 jobs:
-  build-native:
+  build-native-image:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -33,7 +33,7 @@ jobs:
           retention-days: 1
 
   build-image:
-    needs: build-native
+    needs: build-native-image
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6

.github/workflows/release.yml

@@ -60,7 +60,7 @@ jobs:
           server-password: CENTRAL_PASSWORD
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
           gpg-passphrase: MAVEN_GPG_PASSPHRASE
-      - run: $MVN deploy -P prod,op,feature-pack,standalone,os,release
+      - run: $MVN deploy -P prod,op,feature-pack,standalone,jbang,os,release
         env:
           CENTRAL_USERNAME: ${{ secrets.CENTRAL_USERNAME }}
           CENTRAL_PASSWORD: ${{ secrets.CENTRAL_PASSWORD }}

CHANGELOG.md

@@ -7,13 +7,16 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
-## [0.2.1] - 2026-03-05
-
 ### Added
 
 - Add Galleon feature pack
 - Add JBang integration
 
+## [0.2.1] - 2026-03-05
+
+> [!WARNING]
+> Not an official release. Please don't use!
+
 ## [0.2.0] - 2026-03-05
 
 > [!WARNING]

README.md

@@ -6,7 +6,7 @@ OpenShift version (halOS). To distinguish between the two editions, we introduce
 - halOP: HAL on premise
 - halOS: HAL on OpenShift
 
-The work is in a very early state and very much in progress.
+The work on the new consoles is in an early state and very much in progress.
 
 # Technical Stack
 
@@ -19,128 +19,144 @@ The work is in a very early state and very much in progress.
 
 # halOP (HAL On Premise)
 
-This edition is the successor of the current [HAL management console](https://github.com/hal/console). It is shipped with
-WildFly or can be run as a standalone application to connect to arbitrary WildFly instances.
+This edition is the successor of the current [HAL management console](https://github.com/hal/console).
 
-## Development
+## Get Started
 
-In the development mode, the Java code is transpiled to JavaScript using J2CL. The HTML and CSS are transpiled to JavaScript
-using Parcel. Changes to HTML and CSS will be detected by Parcel, and the browser reloads the page automatically.
-Changes to the Java code will be detected by the J2CL Maven plugin, but you need to reload the browser manually.
+There are many ways to get started with halOP, but essentially there are two ways to use the console:
 
-To start halOP in development mode, run
+1. Bundled – as part of a WildFly installation
+2. Standalone – as a single-page application ([SPA](https://en.wikipedia.org/wiki/Single-page_application)) running on its own
 
-```shell
-mvn j2cl:watch -P op
-```
+### Bundled
 
-and wait until you see the message
+In this mode halOP is bundled with WildFly and can be used out of the box. halOP is available as an experimental feature pack
+that can be provisioned with [Galleon](https://github.com/wildfly/galleon). The feature pack mounts an additional HTTP endpoint
+on the management interface: http://localhost:9990/halop
 
-```
-[INFO] -----  Build Complete: ready for browser refresh  -----
-```
+1. Build or use the latest feature pack from Maven Central [
+   `org.jboss.hal:hal-op-feature-pack:<VERSION>`](https://central.sonatype.com/artifact/org.jboss.hal/hal-op-feature-pack)
 
-In another shell run
+    ```shell
+    mvn install -P prod,op,feature-pack
+    ```
 
-```shell
-cd op/console
-npm run watch
-```
+2. Provision a WildFly server. You can use the provided [
+   `provision.xml`](https://github.com/hal/foundation/blob/main/op/feature-pack/provision.xml) as an example. It provisions a
+   default standalone server plus the halOP feature pack. If you haven't built the feature pack in step 1 and used the latest
+   version from Maven Central, you have to run `mvn process-resources` in `op/feature-pack` in order to resolve the version
+   numbers.
 
-This will open a browser at http://localhost:1234.
+    ```shell
+    galleon.sh provision op/feature-pack/target/provision.xml \
+        --dir=$TMPDIR/wildfly \
+        --stability-level=experimental
+    ```
+
+3. Prepare and start the server
+
+    ```shell
+    cd $TMPDIR/wildfly
+    bin/add-user.sh -u admin -p admin --silent
+    bin/standalone.sh --stability=experimental
+    ```
 
-## Standalone
+4. Open http://localhost:9990/halop
+
+### Standalone
 
 halOP can run on its own. In this mode halOP starts a local web server and serves the console on its own without being part of a
-WildFly installation. halOP is "just" a single-page application (SPA) without any server side dependencies. The only requirement
-is a management interface of a running WIldFly instance.
+WildFly installation. halOP is "just" a single-page application ([SPA](https://en.wikipedia.org/wiki/Single-page_application))
+without any server side dependencies. The only requirement is a management interface of a running WIldFly instance.
+
+By default, halOP is available at http://localhost:9090. If you want to customize the port, please use
+`-Dquarkus.http.port=<port>`.
 
-### Java
+There are many ways to run halOP in standalone mode:
 
-To build halOP as a standalone Java application, run
+#### Build and run on your own (JVM)
 
 ```shell
 mvn install -P prod,op,standalone
+java -jar op/standalone/target/quarkus-app/quarkus-run.jar
 ```
 
-This will package the transpiled HTML, CSS, and JavaScript resources into a Quarkus-based HTTP server. To start it, run
+#### Build and run on your own (native)
 
 ```shell
-java -jar op/standalone/target/hal-op-standalone-0.2.1.jar
+mvn install -P prod,op,standalone,native
+op/standalone/target/hal-op-standalone-<VERSION>-runner
 ```
 
-and open a browser at http://localhost:9090.
+Please make sure that you have a recent version of GraalVM installed.
+See https://quarkus.io/guides/building-native-image#configuring-graalvm for details.
 
-### Native
+#### Latest release (JVM)
 
-To build the native binary of halOP, run
+The latest release is deployed as Uber-Jar using the `runner` classifier to Maven Central: [
+`org.jboss.hal:hal-op-standalone:<VERSION>`](https://central.sonatype.com/artifact/org.jboss.hal/hal-op-standalone). You can
+download and run it with
 
 ```shell
-mvn install -P prod,op,standalone,native -Dquarkus.native.container-build=false
+mvn dependency:copy -Dartifact=org.jboss.hal:hal-op-standalone:<VERSION>:jar:runner -DoutputDirectory=.
+java -jar hal-op-standalone-<VERSION>-runner.jar
 ```
 
-Please make sure that you have a recent version of GraalVM installed.
-See https://quarkus.io/guides/building-native-image#configuring-graalvm for details.
-
-Native binaries for Linux, macOS, and Windows are also attached to every [release](https://github.com/hal/foundation/releases).
-Download the binary for your platform, make it executable, and run it. Then open a browser at http://localhost:9090.
+#### Latest release (native)
 
-To make the binary executable, you might need to run something like this:
+Native binaries for Linux, macOS, and Windows are attached to every [release](https://github.com/hal/foundation/releases).
+Download the binary for your platform, make it executable, and run it. To make the binary executable, you might need to run
+something like this (depending on your OS):
 
 ```shell
 chmod +x hal-op-*
 xattr -d com.apple.quarantine hal-op-*
 ```
 
-If you want to customize the port of halOP (Java-based and native), please use `-Dquarkus.http.port=<port>` to change the port.
+#### JBang
 
-## JBang
-
-halOP can also be run as a standalone Java application using [JBang](https://jbang.dev/).
+halOP is also available as
+a [JBang](https://jbang.dev/) [catalog](https://www.jbang.dev/documentation/jbang/latest/alias_catalogs.html#catalogs):
 
 ```shell
 jbang hal-op@hal
 ```
 
-## Container
+#### Container
 
-halOP is also available as a container image at https://quay.io/repository/halconsole/hal-op. Use
+halOP is also available as a container image at https://quay.io/repository/halconsole/hal-op.
 
 ```shell
 podman run -it -p 9090:9090 quay.io/halconsole/hal-op
 ```
 
-to start it and open a browser at http://localhost:9090.
-
-## Galleon Provisioning
+## Development
 
-halOP is also available as a feature pack that can be provisioned with [Galleon](https://github.com/wildfly/galleon).
+If you want to contribute to halOP, follow these steps to start halOP in development mode. In the development mode, the Java
+code is transpiled to JavaScript using J2CL. The HTML and CSS are transpiled to JavaScript
+using Parcel. Changes to HTML and CSS will be detected by Parcel, and the browser reloads the page automatically.
+Changes to the Java code will be detected by the J2CL Maven plugin, but you need to reload the browser manually.
 
-1. Build the feature pack with
+To start halOP in development mode, run
 
-    ```shell
-    mvn install -P prod,op,feature-pack
-    ```
+```shell
+mvn j2cl:watch -P op
+```
 
-2. Provision a WildFly server. You can use the provided [
-   `provision.xml`](https://github.com/hal/foundation/blob/main/op/feature-pack/provision.xml) as an example. It provisions a
-   default standalone server plus the halOP feature pack.
+and wait until you see the message
 
-    ```shell
-    galleon.sh provision op/feature-pack/target/provision.xml \
-        --dir=$TMPDIR/wildfly \
-        --stability-level=experimental
-    ```
+```
+[INFO] -----  Build Complete: ready for browser refresh  -----
+```
 
-3. Prepare and start the server
+In another shell run
 
-    ```shell
-    cd $TMPDIR/wildfly
-    bin/add-user.sh -u admin -p admin --silent
-    bin/standalone.sh --stability=experimental
-    ```
+```shell
+cd op/console
+npm run watch
+```
 
-4. Open http://localhost:9990/halop
+This will open a browser at http://localhost:1234.
 
 # halOS (HAL on OpenShift)
 

op/standalone/pom.xml

@@ -37,7 +37,6 @@
         <compiler-plugin.version>3.15.0</compiler-plugin.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <quarkus.package.jar.type>uber-jar</quarkus.package.jar.type>
         <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
         <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
         <quarkus.platform.version>3.32.2</quarkus.platform.version>
@@ -145,6 +144,12 @@
     </build>
 
     <profiles>
+        <profile>
+            <id>jbang</id>
+            <properties>
+                <quarkus.package.jar.type>uber-jar</quarkus.package.jar.type>
+            </properties>
+        </profile>
         <profile>
             <id>native</id>
             <activation>

op/standalone/src/main/resources/application.properties

@@ -17,4 +17,3 @@
 quarkus.banner.path=banner.txt
 quarkus.http.port=9090
 quarkus.native.march=compatibility
-quarkus.package.jar.add-runner-suffix=false