Chapter 3. Generating an example configuration file for your Quarkus application

You can create an application.properties.example file with all of the available configuration values and documentation for the extensions that your application is configured to use. You can repeat this procedure after you install a new extension to see what additional configuration options have been added.

Prerequisites

  • Have a Quarkus Maven project.

Procedure

  • To create an application.properties.example file, enter the following command:

    ./mvnw quarkus:generate-config

    This command creates the application.properties.example file in the src/main/resources/ directory. The file contains all of the configuration options exposed through the extensions that you installed. These options are commented out and have a default value where applicable.

    The following example shows the HTTP port configuration entry from the application.properties.example file:

    #quarkus.http.port=8080