Server Plugin

HttpsRedirect

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

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

ネイティブサーバー

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。