ssl-server

Sumor Cloud ツール。
詳しいドキュメント

Expressを使用したSSL Webサーバー、HTTP/2をサポート

CI Test Coverage Audit

インストール

npm i @sumor/ssl-server --save

前提条件

Node.JSのバージョン

Node.JSのバージョン18.x以上が必要です

Node.JS ESモジュールの必要性

このパッケージはESモジュールで書かれているため、package.jsonファイル内の以下のコードを変更してください:

{
  "type": "module"
}

使用法

シンプルなサーバーのホスティング

import createApp from '@sumor/ssl-server'
const app = createApp()

// 指定しない場合はポート443でリッスンし、80をhttps 443にリダイレクトします
await app.listen()

console.log('Server running at https://localhost:443/')

SSLファイルの追加

SSLファイルを次の名前でルートフォルダのsslに追加してください:

見つからない場合、サーバーは自己署名証明書を生成します。
SSLファイルが変更されると、自動的にリロードされます。

機能

全てのexpressの機能をサポートしていますが、listen および closeメソッドに違いがあります。詳細については以下の例を参照してください。

ミドルウェアとルートの追加

import createApp from '@sumor/ssl-server'
const app = createApp()
import bodyParser from 'body-parser'

// 任意のexpressミドルウェアを追加できます
app.use(bodyParser.json())

// ルートを追加
app.get('/', (req, res) => {
  res.send('Hello World!')
})

// listenは非同期関数です
await app.listen()

サーバーを強制的に閉じる

import createApp from '@sumor/ssl-server'
const app = createApp()

// listenは非同期関数です
await app.listen()
// closeは非同期関数です
await app.close()

カスタムポートでリッスン

import createApp from '@sumor/ssl-server'
const app = createApp()

// listenは非同期関数です
await app.listen(8443, 8080)
console.log(`Server is running on https://localhost:8443/`)
console.log(`Redirect server is running on http://localhost:8080/`)

httpのみでリッスン

import createApp from '@sumor/ssl-server'
const app = createApp()

// listenは非同期関数です
await app.listen(null, 8080)
console.log(`Redirect server is running on http://localhost:8080/`)

カスタムアプリの使用

デフォルトでは、sslサーバーは最新のexpressのロングタームサポートバージョンを使用します。createApp関数に渡して独自のexpressアプリを使用できます。

import createApp from '@sumor/ssl-server'
import express from 'express'

const expressApp = express()
expressApp.get('/', (req, res) => {
  res.send('Hello World!')
})

const app = createApp(expressApp)

// listenは非同期関数です
await app.listen()

console.log('Server running at https://localhost:443/')