Configuration reference
Quarkus Modulith
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Configuration property |
Type |
Default |
|---|---|---|
Whether to write the module documentation (PlantUML and Mermaid diagrams, module canvases, aggregating document and overview) when the application is packaged. Environment variable: |
boolean |
|
Whether to write the documentation in dev mode too, on every reload. Off by default to keep reloads fast. Environment variable: |
boolean |
|
The directory the documentation is written to. Relative paths are resolved against the build output directory ( Environment variable: |
string |
|
Whether to delete the content of the output directory before writing, so files of renamed or removed modules do not linger. Spring Modulith’s Environment variable: |
boolean |
|
The diagram style: Environment variable: |
|
|
How far the diagram of a module follows the modules whose beans it uses. Environment variable: |
|
|
The dependency types drawn. All types when not set. Environment variable: |
list of |
|
Whether modules without a relationship to another module of the diagram are shown. Environment variable: |
|
|
The groups beans are listed in. Environment variable: |
|
|
Whether internal beans and types are listed as well. Environment variable: |
boolean |
|
Whether rows without content are written. Environment variable: |
boolean |
|
The base URL of the application’s Javadoc. When set, types link to their Javadoc page. Environment variable: |
string |
|
Whether to serve the module model as JSON. Needs an HTTP extension such as Environment variable: |
boolean |
|
The path of the endpoint, relative to the non-application root path ( Environment variable: |
string |
|
The module under test, given as a module identifier or as any package inside the module. When set, beans of modules that are not part of the test are excluded from the application. Environment variable: |
string |
|
Which other modules are started together with the module under test. Environment variable: |
|
|
Additional modules to start, by identifier. Environment variable: |
list of string |
|
Whether a module test build fails on any module rule violation of the application, also when Environment variable: |
boolean |
|
Read by Environment variable: |
boolean |
|
Read by Environment variable: |
string |
|
Read by Environment variable: |
string |
|
Read by Environment variable: |
string |
|
The base package of the application. Every direct sub-package is an application module. When not set, the package of the type annotated with Environment variable: |
string |
|
How modules are found: Environment variable: |
string |
|
The name of the system, overriding Environment variable: |
string |
|
Identifiers of modules every other module may depend on, in addition to Environment variable: |
list of string |
|
Further root packages whose sub-packages are modules, in addition to Environment variable: |
list of string |
|
Whether module identifiers default to the full package name, overriding Environment variable: |
boolean |
|
Packages left out of the model, in ArchUnit’s notation: Environment variable: |
list of string |
|
Whether Environment variable: |
boolean |
|
What to do when the module rules are broken: Environment variable: |
|
|
Whether test classes are part of the module model. Off by default, like in Spring Modulith, so that tests placed in a module package may use the internals of other modules. Environment variable: |
boolean |
|
Whether beans of other modules may be injected into fields. Spring Modulith reports field injection across modules as violation and asks for constructor injection. Quarkus recommends package-private field injection, so it is allowed by default. Set to Environment variable: |
boolean |
|
Fully qualified names of Environment variable: |
list of string |
|
Whether to run the jMolecules DDD and architecture rules of Environment variable: |
boolean |
|
Whether the build writes the model in Spring Modulith’s Environment variable: |
boolean |
|
Where asynchronous listeners run: the Quarkus Environment variable: |
|
|
How long the application waits at shutdown for listeners that are still running, like Spring Modulith’s Environment variable: |
|
|
When a publication is marked completed: Environment variable: |
|
|
Whether the Environment variable: |
boolean |
|
|
About the Duration format
To write duration values, use the standard You can also use a simplified format, starting with a number:
In other cases, the simplified format is translated to the
|
Event publication registry
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Configuration property |
Type |
Default |
|---|---|---|
Whether events are externalized when a transport is present, for example Environment variable: |
boolean |
|
How events reach the broker: Environment variable: |
|
|
What happens to a publication once its listener succeeded: Environment variable: |
|
|
When set, only CDI observers notified Environment variable: |
string |
|
Whether to submit all incomplete publications again when the application starts. The resubmission runs in the background after startup, in batches. With several instances of the application, prefer Environment variable: |
boolean |
|
How often to submit incomplete publications again. Disabled when not set. Needs Environment variable: |
||
Only publications older than this are submitted again by the periodic job, so that deliveries still in flight are left alone. Without Environment variable: |
|
|
How many publications a resubmission reads from the store at once. Must be positive. Environment variable: |
int |
|
How often to delete completed publications. Disabled when not set. Needs Environment variable: |
||
Completed publications whose completion is older than this are deleted by the periodic job. Environment variable: |
|
|
After how long a Environment variable: |
||
After how long a Environment variable: |
||
After how long a Environment variable: |
||
How often to look for stale publications. Must be positive. Needs Environment variable: |
|
|
Publications with at least this many completion attempts are abandoned: they are no longer resubmitted and are listed by Environment variable: |
int |
|
Whether the default externalization configuration sends events one at a time, so that the broker sees them in the order they were published. Like Spring Modulith’s Environment variable: |
boolean |
|
When externalization is serialized, how long one send may wait for the broker’s acknowledgement. A send that takes longer fails, and the next event is sent, so that a broker that never answers cannot stop externalization. Environment variable: |
|
|
How often the job looks for publications to send, in addition to running after every transaction that recorded events. Publications that failed are sent again on the next run. Environment variable: |
|
|
How long to wait for the broker to acknowledge a message before the publication counts as failed and the run stops, so that later events do not overtake it. Environment variable: |
|
|
How long, on top of Environment variable: |
|
|
How many publications a run reads at once. Must be at least 1. Environment variable: |
int |
|
|
About the Duration format
To write duration values, use the standard You can also use a simplified format, starting with a number:
In other cases, the simplified format is translated to the
|