server.origin example
Example of server.origin configuration: export default defineConfig({ server: { origin: 'http://127.0.0.1:8080' } })
Vite · Config reference · all subjects
server options: core
21 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.
server.sourcemapIgnoreList example
Example of server.sourcemapIgnoreList configuration: export default defineConfig({ server: { sourcemapIgnoreList(sourcePath, sourcemapPath) { return sourcePath.includes('node_modules') } } })
server.middlewareMode example with Express
Example of server.middlewareMode with Express: import express from 'express'; import { createServer as createViteServer } from 'vite'; async function createServer() { const app = express(); const vite = await createViteServer({ server: { middlewareMode: true }, appType: 'custom' }); app.use(vite.middlewares); app.use('*', async (req, res) => { }) }
server.host CLI configuration
The server.host option can be set via the CLI using '--host 0.0.0.0' or '--host' flags.
server.host type and default
The server.host option is of type 'string | boolean' with a default value of 'localhost'. It specifies which IP addresses the server should listen on. Setting it to '0.0.0.0' or 'true' makes the server listen on all addresses including LAN and public addresses.
server.allowedHosts type and default
The server.allowedHosts option is of type 'string[] | true' with a default value of an empty array []. It specifies the hostnames that Vite is allowed to respond to. Localhost and domains under .localhost and all IP addresses are allowed by default. A string starting with '.' allows that hostname without the '.' and all subdomains.
server.port type and default
The server.port option is of type 'number' with a default value of 5173. If the port is already in use, Vite will automatically try the next available port.
server.strictPort type and behavior
The server.strictPort option is of type 'boolean'. When set to true, it causes Vite to exit if the port is already in use, instead of automatically trying the next available port.
server.https type
The server.https option is of type 'https.ServerOptions'. It enables TLS + HTTP/2 and takes an options object passed to https.createServer(). A valid certificate is required.
server.open type and behavior
The server.open option is of type 'boolean | string'. When true, it automatically opens the app in the browser on server start. When the value is a string, it will be used as the URL's pathname.
server.hmr type and behavior
The server.hmr option is of type 'boolean | { overlay?: boolean }'. It is used to disable or configure HMR behavior. Set server.hmr.overlay to false to disable the server error overlay.
server.ws type and options
The server.ws option is of type 'false | { protocol?: string, host?: string, port?: number, path?: string, timeout?: number, clientPort?: number, server?: Server }'. It configures WebSocket connection options. Set to false to disable the WebSocket connection entirely. protocol is the WebSocket protocol (ws or wss), host is the WebSocket server host, port is the WebSocket server port, path is the WebSocket path, timeout is connection timeout in milliseconds with default 30000, clientPort overrides the port on the client side, and server is a custom HTTP server for WebSocket connections.
server.forwardConsole type and default
The server.forwardConsole option is of type 'boolean | { unhandledErrors?: boolean, logLevels?: ("error" | "warn" | "info" | "log" | "debug")[] }' with a default of auto (true when an AI coding agent is detected based on @vercel/detect-agent, otherwise false). It forwards browser runtime events to the Vite server console during development.
server.warmup type and behavior
The server.warmup option is of type '{ clientFiles?: string[], ssrFiles?: string[] }'. It warms up files to transform and cache the results in advance, improving initial page load during server starts. clientFiles are files used in the client only, ssrFiles are files used in SSR only. They accept an array of file paths or tinyglobby patterns relative to the root.
server.middlewareMode type and default
The server.middlewareMode option is of type 'boolean | { server: http.Server }' with a default value of false. It creates Vite server in middleware mode. If proxy is setup for WebSocket, the server should be provided to bind the proxy correctly.
server.origin type
The server.origin option is of type 'string'. It defines the origin of the generated asset URLs during development.
server.sourcemapIgnoreList type and default
The server.sourcemapIgnoreList option is of type 'false | (sourcePath: string, sourcemapPath: string) => boolean' with a default of (sourcePath) => sourcePath.includes('node_modules'). It determines whether or not to ignore source files in the server sourcemap, used to populate the x_google_ignoreList source map extension.
server.open example with path
Example of server.open configuration: export default defineConfig({ server: { open: '/docs/index.html' } })
server.forwardConsole example
Example of server.forwardConsole configuration: export default defineConfig({ server: { forwardConsole: { unhandledErrors: true, logLevels: ['warn', 'error'] } } })
server.warmup example
Example of server.warmup configuration: export default defineConfig({ server: { warmup: { clientFiles: ['./src/components/*.vue', './src/utils/big-utils.js'], ssrFiles: ['./src/server/modules/*.js'] } } })
server.ws configuration example
Example of server.ws configuration: export default defineConfig({ server: { ws: { protocol: 'wss', host: 'localhost', port: 3001 } } })