maven-assembly-plugin.md

Initial project: ktor-maven-sample

Final project: ktor-maven-sample, the maven-assembly branch

The Maven Assembly plugin provides the ability to combine project output into a single distributable archive that contains dependencies, modules, site documentation, and other files. In this topic, we'll show you how to build an assembly and run it for the ktor-maven-sample application.

Prerequisites {id="prerequisites"}

Before starting this tutorial, clone the ktor-maven-sample repository.

Configure the Assembly plugin {id="configure-plugin"}

To build an assembly, you need to configure the Assembly plugin first:

1. Open the ktor-maven-sample project.

2. Go to the pom.xml file and add maven-assembly-plugin to the plugins block as follows:

   {src="https://raw.githubusercontent.com/ktorio/ktor-maven-sample/maven-assembly/pom.xml" lines="55-76"}

   Among other settings, this configuration contains the Main-Class attribute of the JAR manifest for building an executable JAR.

   If you use EngineMain without the explicit main function, your Main-Class depends on the used engine and might look as follows: io.ktor.server.netty.EngineMain.

Build an assembly {id="build"}

To build an assembly for the application, open the terminal and execute the following command:

mvn package

When this build completes, you should see the mainModule-1.0-SNAPSHOT-jar-with-dependencies.jar file in the target directory.

To learn how to use the resulting package to deploy your application using Docker, see the help topic.

Run the application {id="run"}

To run the built application:

1. Go to the target folder in a terminal.
2. Execute the following command to run the application:

   java -jar mainModule-1.0-SNAPSHOT-jar-with-dependencies.jar

3. Wait until the following message is shown:

   [main] INFO  Application - Responding at http://0.0.0.0:8080

   You can click the link to open the application in a default browser: