Skip to content

Beyond Fast

ViteConf 2023

Watch the replay!

서버 옵션

server.host

  • 타입: string | boolean
  • 기본값: 'localhost'

서버가 수신할 IP 주소를 지정합니다. LAN와 공용 주소를 포함한 모든 주소를 수신하려면 이 값을 0.0.0.0 또는 true로 설정하세요.

CLI에서는 --host 0.0.0.0 or --host로 설정될 수 있습니다.

참고

Vite 대신 다른 서버가 응답하는 경우가 있습니다.

첫 번째 경우는 localhost를 사용하는 경우입니다. Node.js 버전이 v17 미만이라면 기본적으로 DNS로 확인된 주소의 결과를 재정렬합니다. localhost에 접근할 때 브라우저는 DNS를 사용해 주소를 확인하며, 해당 주소는 Vite가 수신하고 있는 주소와 다를 수 있습니다.

이 재정렬 동작을 비활성화하려면 dns.setDefaultResultOrder('verbatim')으로 설정해주세요. 이 때 Vite는 주소를 localhost로 표기합니다.

js
// vite.config.js
import { 
defineConfig
} from 'vite'
import
dns
from 'node:dns'
dns
.
setDefaultResultOrder
('verbatim')
export default
defineConfig
({
// 생략 })

두 번째 경우는 와일드카드 호스트(예: 0.0.0.0)가 사용되는 경우입니다. 와일드카드 호스트는 명시적으로 지정된 호스트보다 우선 순위가 낮기 때문에 이러한 상황이 발생될 수 있습니다.

LAN에서 WSL2의 서버에 액세스하기

WSL2에서 Vite를 실행할 때, host: true를 설정하는 것만으로는 LAN에서 서버에 접근할 수 없습니다. 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) 환경 변수를 설정할 수 있습니다. 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가 비상대적(Non-relative)인 경우, 각 키에 base를 접두사로 붙여야 합니다.

이는 http-proxy를 확장합니다. 추가 옵션은 여기를 참고해주세요.

특정 상황(예: 서버 내부에서 사용되는 connect 앱에 커스텀 미들웨어 추가)에서는 개발 서버를 직접 구성해야 할 수도 있습니다. 이를 위해서는 플러그인을 작성하고, 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/, '')
      },
      // 정규식(RegEx)과 함께: 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) => {
          // proxy 변수에는 'http-proxy'의 인스턴스가 전달됩니다
        }
      },
      // 웹소켓 또는 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 | false, path?: string, timeout?: number, overlay?: boolean, clientPort?: number, server?: Server }

HMR 연결을 설정하거나 사용하지 않을 수 있습니다. (HMR 웹 소켓이 http 서버와 다른 주소를 사용해야 하는 경우)

서버 오류 오버레이를 사용하지 않으려면 server.hmr.overlayfalse로 설정하세요.

protocol은 HMR 연결에 사용되는 웹소켓 프로토콜을 설정합니다: ws (웹소켓) 또는 wss (보안 웹소켓) 값을 갖습니다.

clientPort는 클라이언트 측의 포트만 재정의하는 고급 옵션으로, 클라이언트 코드에서 찾는 것과 다른 포트에서 웹 소켓을 제공할 수 있습니다.

server.hmr.server 옵션이 정의되면 Vite는 제공된 서버를 통해 HMR 연결 요청을 처리합니다. 미들웨어 모드가 아니라면, Vite는 기존 서버를 통해 HMR 연결 요청을 처리합니다. 이는 자체적으로 서명된 인증서를 사용하거나 단일 포트의 네트워크를 통해 Vite를 제공하려는 경우 유용합니다.

예제는 vite-setup-catalogue를 참고해주세요.

참고

기본적으로 Vite는 리버스 프락시가 WebSocket 프락시를 지원한다고 가정하고 동작합니다. 만약 Vite HMR 클라이언트가 WebSocket 연결에 실패하게 되면, 클라이언트는 리버스 프락시 대신 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.port를 [server.port](#server-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에 전달할 파일 시스템 감시자(Watcher) 옵션입니다.

Vite 서버 감시자는 기본적으로 root를 감시하고, .git/, node_modules/, 그리고 Vite의 cacheDirbuild.outDir 디렉터리는 건너뜁니다. 감시하는 파일을 업데이트하면, Vite는 HMR을 적용하고, 필요한 경우에만 페이지를 업데이트합니다.

null로 설정하면 어떤 파일도 감시하지 않습니다. server.watcher는 기존과 동일한 API를 갖는 이벤트 이미터(Emitter)를 제공하지만, add 또는 unwatch를 호출해도 아무런 영향을 미치지 않습니다.

node_modules 디렉터리에서 파일 감시하기

현재 node_modules 디렉터리의 파일과 패키지는 감시할 수 없습니다. 더 많은 진행 상황과 해결 방법은 #8619 이슈를 참고해 주세요.

Windows Subsystem for Linux (WSL) 2 에서 Vite 사용하기

WSL2에서 Vite를 실행할 때, WSL2가 아닌 타 Windows 응용 프로그램에서 파일을 편집하면 파일 시스템 변경사항 감시 기능이 정상적으로 동작하지 않습니다. 이는 WSL2 제한사항으로 인한 것이며, WSL2 백엔드가 존재하는 Docker에서 실행하는 경우에도 동일합니다.

이를 해결하기 위해 아래 중 하나를 시도할 수 있습니다:

  • 권고 사항: WSL2 응용 프로그램을 사용해 파일을 편집
    • 또한 WSL2에서 Windows 파일 시스템에 접근하는 것은 느리기 때문에 프로젝트 폴더를 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
: 'ssr' },
appType
: 'custom' // Vite의 기본 HTML 처리용 미들웨어를 사용하지 마세요
}) // Vite의 연결(Connect) 인스턴스를 미들웨어로 사용
app
.use(
vite
.
middlewares
)
app
.use('*', async (
req
,
res
) => {
// `appType`은 `'custom'`이므로 여기에서 반환될 데이터(Response)를 제공해야 합니다. // 참고: `appType`이 `'spa'` 또는 `'mpa'`인 경우, // Vite는 HTML 요청과 404를 처리하는 미들웨어를 포함하므로 // Vite의 미들웨어가 적용되기 전에 사용자 미들웨어를 추가해야 합니다. }) }
createServer
()

server.fs.strict

  • 타입: boolean
  • 기본값: true (Vite 2.7에서 기본적으로 활성화되도록 변경되었습니다.)

작업영역 루트 외부에 있는 파일 제공을 제한합니다.

server.fs.allow

  • 타입: string[]

/@fs/를 통해 제공될 수 있는 파일을 제한합니다. server.fs.stricttrue로 설정된 경우, 이 목록에 포함되지 않았으며 허용된 파일에서 import 되는 것도 아닌 외부 파일에 접근하면 403 결과를 반환합니다.

디렉터리와 파일 모두 제공될 수 있습니다.

Vite는 잠재적인 작업 공간의 루트를 검색하여 기본값으로 사용합니다. 유효한 작업 공간은 다음 조건을 충족합니다. 그렇지 않으면 프로젝트 루트로 대체됩니다.

  • package.jsonworkspaces 필드가 포함됨
  • 다음 파일 중 하나를 포함함
    • lerna.json
    • pnpm-workspace.yaml

사용자 지정 작업 공간 루트를 지정하는 경로를 허용합니다. 절대 경로 또는 프로젝트 루트에 대한 상대 경로일 수 있습니다. 다음은 하나의 예입니다:

js
export default defineConfig({
  server: {
    fs: {
      // 프로젝트 루트 바로 위 까지의 파일만 접근 가능
      allow: ['..']
    }
  }
})

만약 server.fs.allow 옵션이 지정되면, 자동으로 작업 영역의 루트를 감지하는 기능이 비활성화됩니다. 이후 기존의 동작을 확장하기 위해 searchForWorkspaceRoot 유틸리티가 노출됩니다:

js
import { defineConfig, searchForWorkspaceRoot } from 'vite'

export default defineConfig({
  server: {
    fs: {
      allow: [
        // 작업 공간(Workspace)의 루트를 지정
        searchForWorkspaceRoot(process.cwd()),
        // 커스텀 allow 옵션 규칙
        '/path/to/custom/allow_directory',
        '/path/to/custom/allow_file.demo',
      ]
    }
  }
})

server.fs.deny

  • 타입: string[]
  • 기본값: ['.env', '.env.*', '*.{crt,pem}']

Vite dev 서버에서 제공되지 않기를 원하는 민감한 파일들에 대한 차단 목록입니다. 이 옵션은 server.fs.allow보다 높은 우선 순위를 가지며, 피코매치 패턴을 사용할 수 있습니다.

server.origin

  • 타입: string

에셋 URL에 대한 origin 헤더를 정의합니다.

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와 동일합니다. 두 구성 옵션 사이의 차이점은 sourcePath에 대한 상대 경로로 rollup 함수가 호출되는 동안 server.sourcemapIgnoreList는 절대 경로로 호출된다는 것입니다. 개발 중에 대부분의 모듈은 맵과 소스가 동일한 폴더에 있으므로 sourcePath에 대한 상대 경로는 파일 이름 자체입니다. 이러한 경우 절대 경로를 사용하면 편리합니다.

기본적으로 node_modules가 포함된 경로를 모두 제외합니다. 이 동작을 비활성화하려면 false를 전달하거나, 함수를 전달해 소스와 소스맵 경로를 받아 소스 경로를 무시할지 여부를 반환할 수 있습니다.

js
export default defineConfig({
  
server
: {
// 이는 기본 값으로, node_modules가 경로에 포함된 모든 파일의 경로를 // 무시할 목록에 추가합니다.
sourcemapIgnoreList
(
sourcePath
,
sourcemapPath
) {
sourcePath
.includes('node_modules')
}, }, })

참고

server.sourcemapIgnoreListbuild.rollupOptions.output.sourcemapIgnoreList는 독립적으로 설정해야 합니다. server.sourcemapIgnoreList는 서버 전용 구성이며 정의된 rollup 옵션에서 기본값을 가져오지 않습니다.

Released under the MIT License.