Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

cors?: boolean | CorsOptions

Configure CORS for the dev server. Uses https://github.com/expressjs/cors. Set to true to allow all methods from any origin, or configure separately using an object.

headers?: OutgoingHttpHeaders

Specify server response headers.

host?: string | boolean

Specify which IP addresses the server should listen on. Set to 0.0.0.0 to listen on all addresses, including LAN and public addresses.

https?: ServerOptions<typeof IncomingMessage, typeof ServerResponse>

Enable TLS + HTTP/2. Note: this downgrades to TLS only when the proxy option is also used.

open?: string | boolean

Open browser window on startup

port?: number

Specify server port. Note if the port is already being used, Vite will automatically try the next available port so this may not be the actual port the server ends up listening on.

proxy?: Record<string, string | ProxyOptions>

Configure custom proxy rules for the dev server. Expects an object of { key: options } pairs. Uses http-proxy. Full options here.

Example vite.config.js:

module.exports = {
proxy: {
// string shorthand
'/foo': 'http://localhost:4567/foo',
// with options
'/api': {
target: 'http://jsonplaceholder.typicode.com',
changeOrigin: true,
rewrite: path => path.replace(/^\/api/, '')
}
}
}
strictPort?: boolean

If enabled, vite will exit if specified port is already in use