Skip to content

サーバーオプション

server.host

  • 型: string | boolean
  • デフォルト: 'localhost'

サーバーがリッスンすべき IP アドレスを指定します。 0.0.0.0 もしくは true に設定すると、LAN やパブリックアドレスを含むすべてのアドレスをリッスンします。

これは CLI で --host 0.0.0.0--host を使用して設定できます。

注意

Vite ではなく他のサーバーがレスポンスを返す場合があります。

1 つ目の場合は localhost が利用されたときです。Node.js v17 未満はデフォルトでは DNS によって解決された結果のアドレスを並び替えます。localhost へアクセスするとき、ブラウザーは DNS を利用してアドレスを解決し、そのアドレスは Vite がリッスンしているアドレスと異なる場合があります。アドレスが異なっている場合は Vite は解決したアドレスを表示します。

dns.setDefaultResultOrder('verbatim') を設定することで、この並び替える動作を無効化できます。そうすると、Vite はアドレスを localhost と出力します。

js
// vite.config.js
import { 
defineConfig
} from 'vite'
import
dns
from 'note:dns'
dns
.setDefaultResultOrder('verbatim')
export default
defineConfig
({
// 省略 })

2 つ目の場合はワイルドカードホスト(例: 0.0.0.0)が利用されたときです。これは、ワイルドカードでないホストにリッスンしているサーバーが、ワイルドカードをリッスンしているサーバーよりも優先されるためです。

LAN から WSL2 上のサーバーにアクセスする

WSL2 上で Vite を動作させる場合、LAN からサーバーにアクセスするために host: true を設定するだけでは不十分です。 詳しくは WSL のドキュメントをご覧ください。

server.port

  • 型: number
  • デフォルト: 5173

サーバーのポートを指定します。このポートがすでに使用されている場合、Vite は次に使用可能なポートを自動的に試すので、サーバーが最終的にリッスンする実際のポートとは異なる場合があることに注意してください。

server.strictPort

  • 型: boolean

true に設定すると、ポートがすでに使用されている場合に、次に使用可能なポートを自動的に試すことなく終了します。

server.https

  • 型: https.ServerOptions

TLS + HTTP/2 を有効にします。server.proxy オプションも使用されている場合にのみ TLS にダウングレードされるので注意してください。

この値は https.createServer() に渡されるオプションオブジェクトでも構いません。

有効な証明書が必要です。基本的なセットアップでは、自己署名証明書を自動的に作成しキャッシュする @vitejs/plugin-basic-ssl をプロジェクトのプラグインに追加することもできます。しかし、独自の証明書を作成することを推奨します。

server.open

  • 型: boolean | string

サーバー起動時に自動的にブラウザーでアプリを開きます。値が文字列の場合、URL のパス名として使用されます。もしあなたの好きなブラウザーでアプリを開きたい場合、環境変数 process.env.BROWSER(例: firefox)を定義できます。詳細は open パッケージ をご覧ください。また、process.env.BROWSER_ARGS を設定して、追加の引数を渡すこともできます(例: --incognito)。

また、BROWSERBROWSER_ARGS.env ファイルで設定できる特別な環境変数です。詳しくは open パッケージ を参照してください。

例:

js
export default defineConfig({
  server: {
    open: '/docs/index.html',
  },
})

server.proxy

  • 型: Record<string, string | ProxyOptions>

開発サーバーのカスタムプロキシのルールを設定します。{ key: options } のペアのオブジェクトが必要です。リクエストパスがそのキーで始まるすべてのリクエストは、その指定されたターゲットにプロキシされます。キーが ^ で始まる場合は RegExp として解釈されます。プロキシのインスタンスにアクセスするには configure オプションを使用します。

相対的でない base を使用する場合、各キーの先頭に base を付けなければならないことに注意してください。

http-proxy を拡張します。他のオプションはこちら

場合によっては、基盤となる開発サーバーを設定したいこともあるでしょう(例: 内部の connect アプリにカスタムミドルウェアを追加する場合など)。そのためには、独自の plugin を書き、configureServer 関数を使用する必要があります。

例:

js
export default defineConfig({
  server: {
    proxy: {
      // 文字列のショートハンド: http://localhost:5173/foo -> http://localhost:4567/foo
      '/foo': 'http://localhost:4567',
      // オプションを使用: http://localhost:5173/api/bar-> http://jsonplaceholder.typicode.com/bar
      '/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/api/, ''),
      },
      // 正規表現を使用: http://localhost:5173/fallback/ -> http://jsonplaceholder.typicode.com/
      '^/fallback/.*': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/fallback/, ''),
      },
      // プロキシインスタンスを使用
      '/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        configure: (proxy, options) => {
          // プロキシは 'http-proxy' のインスタンスになります
        },
      },
      // Web ソケット か socket.io をプロキシ化: ws://localhost:5173/socket.io -> ws://localhost:5174/socket.io
      '/socket.io': {
        target: 'ws://localhost:5174',
        ws: true,
      },
    },
  },
})

server.cors

  • 型: boolean | CorsOptions

開発サーバーの CORS を設定します。これはデフォルトで有効になっており、どんなオリジンも許可します。オプションオブジェクトを渡して微調整するか、false で無効にします。

server.headers

  • 型: OutgoingHttpHeaders

サーバーのレスポンスヘッダーを指定します。

server.hmr

  • 型: boolean | { protocol?: string, host?: string, port?: number, path?: string, timeout?: number, overlay?: boolean, clientPort?: number, server?: Server }

HMR 接続の無効化または設定(HMR WebSocket が http サーバーと異なるアドレスを使用する必要がある場合)。

server.hmr.overlayfalse に設定すると、サーバーエラーのオーバレイが無効になります。

protocol は、HMR 接続のために使われる WebSocket プロトコルを設定します: ws(WebSocket)または wss(WebSocket Secure)

clientPort は、クライアント側のポートのみを上書きする高度なオプションで、クライアントコードが探すポートとは異なるポートで WebSocket を配信できます。

server.hmr.server を指定されている場合、Vite は指定されたサーバーを通して HMR 接続要求を処理します。ミドルウェアモードでない場合、Vite は既存のサーバーを通して HMR 接続要求を処理しようとします。これは、自己署名証明書を使用する場合や、Vite を単一ポートでネットワーク上に公開したい場合に役立ちます。

いくつかの例については、vite-setup-catalogueをご覧ください。

注意

デフォルトの設定では、Vite の前のリバースプロキシが WebSocket のプロキシに対応していることが期待されています。Vite の HMR クライアントが WebSocket の接続に失敗した場合、クライアントはリバースプロキシを迂回して直接 Vite の HMR サーバーに接続するようにフォールバックします:

Direct websocket connection fallback. Check out https://vitejs.dev/config/server-options.html#server-hmr to remove the previous connection error.

フォールバックが発生した際のブラウザーに表示されるエラーは無視できます。直接リバースプロキシを迂回してエラーを回避するには、次のいずれかを行えます:

  • WebSocket もプロキシするようにリバースプロキシを設定する
  • server.strictPort = true を設定し、server.hmr.clientPortserver.port と同じ値に設定する
  • server.hmr.portserver.port とは異なる値に設定する

server.warmup

変換するファイルをウォームアップし、結果を事前にキャッシュします。これにより、サーバー起動時の初期ページ読み込みが改善され、変換ウォーターフォールを防げます。

clientFiles はクライアントのみで使用されるファイルであり、ssrFiles は SSR のみで使用されるファイルです。これらは root を基準としたファイルパスや fast-glob パターンの配列を受け入れます。

起動時に Vite 開発サーバーに負荷がかからないように、頻繁に使用するファイルのみを追加するようにしてください。

js
export default defineConfig({
  server: {
    warmup: {
      clientFiles: ['./src/components/*.vue', './src/utils/big-utils.js'],
      ssrFiles: ['./src/server/modules/*.js'],
    },
  },
})

server.watch

  • 型: object| null

chokidar に渡すファイルシステムウォッチャーのオプションです。

Vite サーバーのウォッチャーはデフォルトで root を監視し、.git/node_modules/、および Vite の cacheDirbuild.outDir ディレクトリーをスキップします。監視されているファイルを更新すると Vite は HMR を適用し、必要な場合にのみページを更新します。

null に設定すると、ファイルは監視されません。server.watcher は互換性のあるイベントエミッターを返しますが、addunwatch を呼び出しても何も起こりません。

node_modules 内のファイルの監視

現在、node_modules 内のファイルやパッケージを監視することはできません。 さらなる進捗状況と回避策については、issue #8619 を参照してください。

Windows Subsystem for Linux (WSL) 2 上での Vite の実行

Vite を WSL2 で実行している際、ファイルシステム監視はファイルが Windows アプリケーション(WSL2 でないプロセス)により編集された場合に動作しません。これは WSL2 の制約 によるものです。これは WSL2 バックエンドの Docker で実行している場合でも該当します。

これを修正するためには、次のいずれかを行えます:

  • 推奨: ファイルを編集するのに WSL2 アプリケーションを使用します。
    • プロジェクトフォルダーを Windows ファイルシステムの外へ移動させることも推奨されます。WSL2 から Windows ファイルシステムへアクセスするのは遅いです。このオーバーヘッドを取り除くことでパフォーマンスが向上します。
  • { usePolling: true } を設定する。

server.middlewareMode

  • 型: boolean
  • デフォルト: false

ミドルウェアモードで Vite サーバーを作成します。

js
import 
express
from 'express'
import {
createServer
as
createViteServer
} from 'vite'
async function
createServer
() {
const
app
=
express
()
// ミドルウェアモードで Vite サーバーを作成 const
vite
= await
createViteServer
({
server
: {
middlewareMode
: true },
appType
: 'custom', // ViteのデフォルトのHTMLを処理するミドルウェアを含めない
}) // vite の接続インスタンスをミドルウェアとして使用
app
.
use
(
vite
.
middlewares
)
app
.
use
('*', async (
req
,
res
) => {
// `appType` が `'custom'` なので、ここでレスポンスを返すべきです。 // 注: `appType` が `'spa'` または `'mpa'` の際は、Vite に HTML リクエスト と 404 になる // リクエストを処理するミドルウェアが含まれます。したがって、ユーザーのミドルウェアが // 動作するためにはViteのミドルウェアよりも前に追加されるべきです。 }) }
createServer
()

server.fs.strict

  • 型: boolean
  • デフォルト: true(Vite 2.7 以降、デフォルトで有効)

ワークスペースのルート以外のファイルの配信を制限します。

server.fs.allow

  • 型: string[]

/@fs/ 経由で配信可能なファイルを制限します。server.fs.stricttrue に設定されている場合、このディレクトリーリストの外にある、許可されたファイルからインポートされていないファイルにアクセスすると、403 が返されます。

ディレクトリーとファイルの両方を指定することができます。

Vite は、潜在的なワークスペースのルートを検索し、それをデフォルトとして使用します。有効なワークスペースは以下の条件を満たすもので、そうでない場合はプロジェクトのルートにフォールバックします。

  • package.jsonworkspaces フィールドが含まれている
  • 以下のファイルのいずれかを含んでいる
    • lerna.json
    • pnpm-workspace.yaml

カスタムワークスペースのルートを指定するパスを受け取ります。絶対パスか、プロジェクトのルートからの相対パスを指定します。例えば:

js
export default defineConfig({
  server: {
    fs: {
      // プロジェクトルートの 1 つ上の階層からファイルを配信できるようにする
      allow: ['..'],
    },
  },
})

server.fs.allow を指定すると、ワークスペースルートの自動検出が無効になります。本来の動作を拡張するために、ユーティリティーの searchForWorkspaceRoot が公開されています:

js
import { defineConfig, searchForWorkspaceRoot } from 'vite'

export default defineConfig({
  server: {
    fs: {
      allow: [
        // ワークスペースルートの検索
        searchForWorkspaceRoot(process.cwd()),
        // あなたのカスタムルール
        '/path/to/custom/allow_directory',
        '/path/to/custom/allow_file.demo',
      ],
    },
  },
})

server.fs.deny

  • 型: string[]
  • デフォルト: ['.env', '.env.*', '*.{crt,pem}']

Vite 開発サーバーでの配信が制限されている機密ファイルのブロックリスト。これは server.fs.allow よりも優先度が高くなります。picomatch パターンがサポートされています。

server.origin

  • 型: string

開発時に生成されるアセット URL のオリジンを定義します。

js
export default defineConfig({
  server: {
    origin: 'http://127.0.0.1:8080',
  },
})

server.sourcemapIgnoreList

  • 型: false | (sourcePath: string, sourcemapPath: string) => boolean
  • デフォルト: (sourcePath) => sourcePath.includes('node_modules')

サーバーのソースマップにあるソースファイルを無視するかどうか。x_google_ignoreList ソースマップ拡張を設定するため使用されます。

server.sourcemapIgnoreList は、開発サーバーの build.rollupOptions.output.sourcemapIgnoreList に相当します。2 つの設定オプションの違いは、rollup の関数が sourcePath の相対パスで呼び出されるのに対して、server.sourcemapIgnoreList は絶対パスで呼び出されることです。開発中、ほとんどのモジュールはマップとソースが同じフォルダーにあるため、sourcePath の相対パスはファイル名そのものになります。このような場合、代わりに絶対パスを使用するのが便利です。

デフォルトでは node_modules を含むすべてのパスを除外します。この動作を無効にするには false を渡します。もしくは、完全に制御するには、ソースパスとソースマップパスを受け取り、ソースパスを無視するかどうかを返す関数を指定します。

js
export default defineConfig({
  server: {
    // これはデフォルトの値であり、パスに node_modules を含むすべての
    // ファイルを無視リストに追加します。
    sourcemapIgnoreList(sourcePath, sourcemapPath) {
      return sourcePath.includes('node_modules')
    },
  },
})

TIP

server.sourcemapIgnoreListbuild.rollupOptions.output.sourcemapIgnoreList は個別に設定する必要があります。server.sourcemapIgnoreList はサーバーのみの設定であり、定義された rollup オプションからデフォルト値を取得しません。

Released under the MIT License. (291cde2d)