Configure options below — the preview updates in real time.
Global build configuration controlling commands, directories, and environment variables.
Directory to change to before starting the build. Useful for monorepos.
Directory containing deploy-ready HTML and assets generated by the build.
Shell command to run to build the site (Bash-compatible syntax supported).
Command to determine if a rebuild is needed. Exit 0 cancels the build, exit 1 continues.
Legacy option for the serverless functions directory. Prefer the [functions] section.
Directory containing Edge Functions source files.
Key-value environment variables injected during the build process. Note: sensitive values should be set in the Netlify UI instead.
Netlify post-processing features for CSS, JS, HTML, and images.
Local development settings for Netlify Dev CLI.
Custom command to start the local development server.
Port the Netlify Dev server is accessible on in the browser.
Port of the underlying application server or framework dev server.
Port where Netlify Dev serves local serverless functions.
Path to the static content folder for local development.
Framework detection mode. Use #auto (default), #static for static file serving, #custom with command/targetPort, or a specific framework ID.
Object path to use for reading JWT roles (e.g. app_metadata.authorization.roles).
Secret used for JWT token verification in local development.
Path to a local SSL certificate file for HTTPS testing.
Path to a local SSL private key file.
Global configuration for Netlify Serverless Functions.
Custom path to the serverless functions directory.
Node.js bundler for packing serverless functions. Defaults to zisi for JavaScript, esbuild for TypeScript.
Node modules to exclude from the bundle but copy without modification.
Glob patterns for extra files and directories to include in the deployment bundle.
Redirect, rewrite, and proxy rules.
Array of redirect rules as JSON. Each has from, to, status (default 301), force (boolean), and optional query, conditions (Language, Country, Role, Cookie), signed, and headers objects.
Custom HTTP header rules applied to matched URL paths.
Array of header rules as JSON. Each has for (path pattern) and values (key-value header pairs). Multi-value headers use triple-quoted strings in TOML.
Netlify Build Plugins to extend the build process.
Array of plugin definitions as JSON. Each has package (NPM package name) and optional inputs (configuration object).
Route and configure Netlify Edge Functions.
Array of edge function routing as JSON. Each has function (name), path or pattern (string or array), optional excludedPath, excludedPattern, cache ("manual"), and header (object with header conditions).
Override build settings for specific deploy contexts (production, deploy-preview, branch-deploy, dev, or a specific branch name).
Build command override for production deployments.
Publish directory override for production deployments.
Environment variables for production context.
Build command override for deploy preview context.
Publish directory override for deploy preview context.
Environment variables for deploy preview context.
Build command override for branch deploy context.
Publish directory override for branch deploy context.
Environment variables for branch deploy context.
Command override for the dev context.
Publish directory override for the dev context.
Netlify Extensions that replace Build Plugins for advanced use cases.
Array of extension definitions as JSON. Each has name (string) and config (object).
Configuration for Deploy to Netlify buttons and templates.
Service names for incoming webhook notifications used with the Deploy to Netlify button.
Key-value map of variable names to human-readable descriptions displayed in the deploy UI.
1