Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WFLY-20447] Fix mistakes in "http custom mechanism" readme #1024

Merged
merged 1 commit into from
Mar 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions http-custom-mechanism/README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ $ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=add-custom-module.cli

NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script.

This creates the custom `__{jbossHomeName}__/modules/modules/org/jboss/as/quickstart/http_custom_mechanism/main` folder, then copies in the `custom-module/target/custom-module.jar` file and creates the required `module.xml` file.
This creates the custom `__{jbossHomeName}__/modules/org/jboss/as/quickstart/http_custom_mechanism/main` folder, then copies in the `custom-module/target/custom-module.jar` file and creates the required `module.xml` file.

You can verify the module structure in your file manager.

Expand Down Expand Up @@ -223,7 +223,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level
include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
// Restore the {productName} Standalone Server Configuration Manually
:restoreScriptName: restore-configuration.cli
include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2]
include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset=+2]

// Additional information about this script
This script reverts the changes made to the `undertow` and `elytron` subsystems. You should see the following result when you run the script.
Expand All @@ -233,9 +233,18 @@ This script reverts the changes made to the `undertow` and `elytron` subsystems
The batch executed successfully
process-state: reload-required
----
// removing the custom module
And finally, to remove the custom module, run the following command, replacing `__{jbossHomeName}__` with the path to your server.
[source,subs="+quotes,attributes+",options="nowrap"]
----
$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=remove-custom-module.cli
----

NOTE: For Windows, use the `__{jbossHomeName}__\bin\jboss-cli.bat` script.


// Restore the {productName} Standalone Server Configuration Manually
include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2]
include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+3]

// Build and run sections for other environments/builds
include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
Expand Down