Skip to content

Commit

Permalink
Merge pull request #54 from tnagao7/update-docs
Browse files Browse the repository at this point in the history
Update readme and usage
  • Loading branch information
tnagao7 authored Jun 24, 2022
2 parents 8e6d270 + 5ae68b3 commit e3ffecd
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 19 deletions.
32 changes: 18 additions & 14 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,26 @@
== Overview
Launcher is an implementation of https://microprofile.io/[MicroProfile].

Launcher 3.0 conforms to MicroProfile 4.1.
Launcher 4.0 supports MicroProfile 5.0 and some APIs from Jakarta EE 9.1.
Currently supported APIs are as follows:

* Jakarta Contexts and Dependency Injection 2.0
* Jakarta RESTful Web Services 2.1
* Jakarta JSON Binding 1.0
* Jakarta JSON Processing 1.1
* Jakarta Annotations 1.3
* MicroProfile Config 2.0
* MicroProfile Fault Tolerance 3.0
* MicroProfile Health 3.1
* MicroProfile JWT Authentication 1.2
* MicroProfile Metrics 3.0
* MicroProfile OpenAPI 2.0
* MicroProfile OpenTracing 2.0
* MicroProfile Rest Client 2.0
* MicroProfile Config 3.0
* MicroProfile Fault Tolerance 4.0
* MicroProfile Health 4.0
* MicroProfile JWT Authentication 2.0
* MicroProfile Metrics 4.0
* MicroProfile OpenAPI 3.0
* MicroProfile OpenTracing 3.0
* MicroProfile Rest Client 3.0
* Jakarta Annotations 2.0
* Jakarta Contexts and Dependency Injection 3.0
* Jakarta Expression Language 4.0
* Jakarta JSON Binding 2.0
* Jakarta JSON Processing 2.0
* Jakarta RESTful Web Services 3.0
* Jakarta Server Pages 3.0
* Jakarta Servlet 5.0
* Jakarta Standard Tag Library 2.0

Launcher provides features to run MicroProfile applications and create portable uber (fat) JARs.
For more details, please refer to link:docs/Usage.adoc[].
Expand Down
32 changes: 27 additions & 5 deletions docs/Usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,42 @@
----
java -jar launcher-<version>.jar
[--config-file file-path]
[--contextroot context-root]
[--http-listener port-number]
[--https-listener port-number]
[--contextroot context-root]
[--libraries jar-filepath[,jar-filepath]*]
[--precompilejsp[=true|=false]]
--deploy war-file
[--generate uber-jar]
[--generate uber-jar-filepath]
----

----
java -jar launcher-<version>.jar
[--config-file file-path]
--execute subcommand
subcommand-args...
----

=== Options
[options="autowidth, header"]
|===
| Name | Description | Default Value
| `--config-file` | Specify the path to configuration file (domain.xml). Do not use `--http-listener` or `--https-listener` when using this option. |
| `--contextroot` | Specify the context-root. | `/`
| `--deploy` | Specify the path to WAR file to deploy. This option is mandatory. |
| `--execute` | Specify the subcommand to execute. |
| `--generate` | Specify the path to uber JAR to generate. When this option is not specified, the application will run automatically. |
| `--http-listener` | Specify HTTP port number. Do not use `--config-file` when using this option. | `8080`
| `--https-listener` |Specify HTTPS port number. Do not use `--config-file` when using this option. | `8181`
| `--deploy` | Specify the path to WAR file to deploy. This option is mandatory. |
| `--contextroot` | Specify the context-root. | `/`
| `--libraries` | Specify the paths to JAR files referred from the application. To specify more than one files, use comma (`,`) as a separator. Files specified in this option will not be included in the generated uber JAR. |
| `--generate` | Specify the path to uber JAR to generate. When this option is not specified, the application will run automatically. |
| `--precompilejsp` | Specify `true` to enable JSP precompilation; `false` to disable. | `false`
|===

=== Operands
[options="autowidth, header"]
|===
| Name | Description
| `subcommand-args` | Specify options and operands for the subcommand.
|===

== Examples
Expand All @@ -36,3 +53,8 @@ $ java -jar launcher-<version>.jar --deploy my-app.war
$ java -jar launcher-<version>.jar --deploy my-app.war --generate my-uber.jar
$ java -jar my-uber.jar
----

* Example 3: Execute the `create-file-user` subcommand.
----
$ java -jar launcher-<version>.jar --config-file domain.xml --execute create-file-user --passwordfile password.txt user1
----

0 comments on commit e3ffecd

Please sign in to comment.