Server Plugin

HttpsRedirect

必須依存関係: io.ktor:ktor-server-http-redirect

コード例: ssl-engine-main-redirect

Native サーバー

Ktor supports Kotlin/Native and allows you to run a server without an additional runtime or virtual machine.

のサポート: ✅

HttpsRedirect プラグインは、呼び出しを処理する前に、すべての HTTP リクエストを HTTPS の対応するリクエストにリダイレクトします。デフォルトでは、リソースは 301 Moved Permanently を返しますが、302 Found を返すように構成することも可能です。

依存関係の追加

HttpsRedirect を使用するには、ビルドスクリプトに ktor-server-http-redirect アーティファクトを含める必要があります：

Gradle (Kotlin)Gradle (Groovy)Maven

HttpsRedirect のインストール

HttpsRedirect プラグインをアプリケーションにインストールするには、指定された

モジュール

Modules allow you to structure your application by grouping routes.

内で install 関数に渡します。 以下のコードスニペットは、HttpsRedirect をインストールする方法を示しています...

• ... embeddedServer 関数の呼び出し内。
• ... Application クラスの拡張関数である、明示的に定義された module 内。

embeddedServermodule

上記のコードは、デフォルトの構成で HttpsRedirect プラグインをインストールします。

リバースプロキシの背後にある場合、HTTPS リクエストを正しく検出するには ForwardedHeader または XForwardedHeader プラグインをインストールする必要があります。これらのプラグインのいずれかをインストールした後に無限リダイレクトが発生する場合は、詳細についてこの FAQ エントリを確認してください。

HttpsRedirect の構成

以下のコードスニペットは、目的の HTTPS ポートを構成し、リクエストされたリソースに対して 301 Moved Permanently を返す方法を示しています：

install(HttpsRedirect) {
    sslPort = 8443
    permanentRedirect = true
}

完全な例はこちらにあります：ssl-engine-main-redirect