Build configuration
You may tell Cloudflare Pages how your site needs to be built as well as where its output files will be located.
Build commands and directories
You should provide a build command to tell Cloudflare Pages how to build your application. For projects not listed here, consider reading the tool’s documentation or framework, and submit a pull request to add it here.
Build directories indicates where your project’s build command outputs the built version of your Cloudflare Pages site. Often, this defaults to the industry-standard public, but you may find that you need to customize it.
Understanding your build configuration
The build command is provided by your framework. For example, the Gatsby framework uses gatsby build as its build command. When you are working without a framework, leave the Build command field blank.
The build directory is generated from the build command. Each framework has its own naming convention, for example, the build output directory is named /public for many frameworks.
The root directory is where your site’s content lives. If not specified, Cloudflare assumes that your linked git repository is the root directory. The root directory needs to be specified in cases like monorepos, where there may be multiple projects in one repository.
Framework presets
Cloudflare maintains a list of build configurations for popular frameworks and tools. These are accessible during project creation. Below are some standard build commands and directories for popular frameworks and tools.
If you are not using a framework, leave the Build command field blank.
| Framework/tool | Build command | Build directory |
|---|---|---|
| Angular (Angular CLI) | ng build |
dist |
| Astro | npm run build |
dist |
| Brunch | brunch build --production |
public |
| Docusaurus | npm run build |
build |
| Eleventy | eleventy |
_site |
| Ember.js | ember build |
dist |
| Expo | expo build:web |
web-build |
| Gatsby | gatsby build |
public |
| GitBook | gitbook build |
_book |
| Gridsome | gridsome build |
dist |
| Hugo | hugo |
public |
| Jekyll | jekyll build |
_site |
| Jigsaw | vendor/bin/jigsaw build production |
build_production |
| mdBook | mdbook build |
book |
| Mkdocs | mkdocs build |
site |
| Next.js (Static HTML Export) | next build && next export |
out |
| Nuxt.js | nuxt generate |
dist |
| Pelican | pelican content [-s settings.py] |
output |
| Quasar | quasar build |
dist/spa |
| React (create-react-app) | npm run build |
build |
| React Static | react-static build |
dist |
| Remix | npm run build |
public |
| Slate | ./deploy.sh |
build |
| Svelte | npm run build |
public |
| Umi | umi build |
dist |
| Vue | npm run build |
public |
| VuePress | vuepress build $directory |
$directory/.vuepress/dist |
Environment variables
If your project makes use of environment variables to build your site, you can provide custom environment variables by going to Account Home > Pages > your Pages project > Settings > Environment variables.
The following system environment variables are injected by default (but can be overridden):
| Environment Variable | Injected value | Example use-case |
|---|---|---|
CF_PAGES |
1 |
Changing build behaviour when run on Pages versus locally |
CF_PAGES_COMMIT_SHA |
<sha1-hash-of-current-commit> |
Passing current commit ID to error reporting, for example, Sentry |
CF_PAGES_BRANCH |
<branch-name-of-current-deployment> |
Customizing build based on branch, for example, disabling debug logging on production |
CF_PAGES_URL |
<url-of-current-deployment> |
Allowing build tools to know the URL the page will be deployed at |
Language support and tools
Cloudflare Pages’ build environment has broad support for a variety of languages, such as Ruby, Node.js, Python, PHP, and Go.
If you need to use a specific version of a language, (for example, Node.js or Ruby) you can specify it by providing an associated environment variable in your build configuration, or setting the relevant file in your source code.
Here are the pinned versions for tools included in the Cloudflare Workers build environment, and how to override them as relevant:
| Language | Default version | Supported versions | Environment variable | File |
|---|---|---|---|---|
| Clojure | ||||
| Elixir | 1.7 | 1.7 only | ||
| Emacs | 25 | 25 only | ||
| Erlang | 21 | 21 only | ||
| Go | 1.14.4 | Any version | GO_VERSION |
|
| Java | 8 | 8 only | ||
| Node.js | 12.18.0 | Any version up to 17.x | NODE_VERSION |
.nvmrc, .node-version |
| PHP | 5.6 | 5.6, 7.2, 7.4 only | PHP_VERSION |
|
| Python | 2.7 | 2.7, 3.5, 3.7 only | PYTHON_VERSION |
runtime.txt, Pipfile |
| Ruby | 2.7.1 | Any version between 2.6.2 and 2.7.5 | RUBY_VERSION |
.ruby-version |
| Swift | 5.2 | Any 5.x version | SWIFT_VERSION |
.swift-version |
| .NET | 3.1.302 |
Many common tools have been pre-installed as well. The environment variable available for overriding the pinned version is specified, as available:
| Tools | Default version | Supported versions | Environment variable |
|---|---|---|---|
| Boot | 2.5.2 | 2.5.2 | |
| Bower | |||
| Cask | |||
| Composer | |||
| Doxygen | Version 1.8.6 | ||
| Emacs | Version 25 | ||
| Gutenberg | (requires environment variable) | Any version | GUTENBERG_VERSION |
| Hugo | Version 0.54.0 | Any version | HUGO_VERSION |
| GNU Make | Version 3.8.1 | ||
| ImageMagick | Version 6.7.7 | ||
| jq | Version 1.5 | ||
| Leiningen | |||
| OptiPNG | Version 0.6.4 | ||
| NPM | Corresponds with Node.js version | Any version | NPM_VERSION |
| pip | Version corresponding with Python version | ||
| Pipenv | Latest version | ||
| sqlite3 | Version 3.11.0 | ||
| Yarn | Version 1.22.4 | Any version from 0.2.0 to 1.22.19 | YARN_VERSION |
| Zola | (requires environment variable) | Any version from 0.5.0 to 0.14.0 | ZOLA_VERSION |
If you want to set a specific version of a framework your Cloudflare Pages project is using, note that Pages will respect your package manager of choice during your build process. For example, if you use Gatsby.js, your package.json should indicate a version of the gatsby npm package, which will be installed using npm install as your project builds on Cloudflare Pages.
Build environment
Cloudflare Pages builds are run in a
gVisor container. The operating system is Ubuntu 20.04.5. The architecture is x86_64.