Choosing an engine
To run a Ktor server application, you need to create and configure a server first. Server configuration includes different settings:
an engine for processing network requests;
host and port values used to access a server;
... and so on.
The table below lists engines supported by Ktor, along with the supported platforms:
Before using the desired engine, you need to add the corresponding dependency to your build script:
Below are examples of adding a dependency for Netty:
Choose how to create a server
A Ktor server application can be created and run in two ways: using the embeddedServer to quickly pass server parameters in code, or using EngineMain to load the configuration from the external
The embeddedServer function accepts an engine factory used to create an engine of a specific type. In the example below, we pass the Netty factory to run a server with the Netty engine and listen on the
EngineMain represents an engine for running a server. You can use the following engines:
EngineMain.main function is used to start a server with the selected engine and loads the application module specified in the external configuration file. In the example below, we start a server from the application's
If you need to start a server using a build system task, you need to configure the required
EngineMain as the main class:
Configure an engine
In this section, we'll take a look at how to specify various engine-specific options.
embeddedServer function allows you to pass engine-specific options using the
configure optional parameter. This parameter includes options common for all engines and exposed by the ApplicationEngine.Configuration class.
In addition to these options, you can configure additional engine-specific properties.
Netty-specific options are exposed by the NettyApplicationEngine.Configuration class.
If you use Jetty as the engine, you can configure the Jetty server inside the configureServer block, which provides access to a Server instance.
CIO-specific options are exposed by the CIOApplicationEngine.Configuration class.
If you use Tomcat as the engine, you can configure it using the configureTomcat property, which provides access to a Tomcat instance.
In a configuration file
If you use
EngineMain, you can specify options common for all engines in a configuration file within the
You can also configure Netty-specific options in a configuration file within the