Deploy VitePress to Bunny Storage

VitePress builds your docs into .vitepress/dist, inside the folder that holds your content.

Setting	Value
Build command	`npm run docs:build`
Output directory	`.vitepress/dist`

Configure VitePress

npx vitepress init names the build script docs:build, but the CLI runs build. Set the build command in bunny.jsonc at your project root. The CLI also expects .vitepress at the project root, so if your docs live in a docs folder, set the output directory too:

bunny.jsonc

{
  "sites": {
    "build": "npm run docs:build",
    "dir": "docs/.vitepress/dist"
  }
}

Leave cleanUrls off. With it on, VitePress writes about.html and links to /about, which returns a 404.

Deploy your site

Bunny CLI
Manually

bunny sites is in Public Preview and available only in the Bunny CLI. It’s in active development, so commands, flags, and behaviour may change. Share feedback on Discord. The storage zone and pull zone behind each site appear in the dashboard under Storage and CDN.

Install the Bunny CLI and log in

curl -fsSL https://cli.bunny.net/install.sh | sh
bunny login

See Installation for npm and other options.

Create a site

From your project root, run:

bunny sites create my-site

Replace my-site with a name for your site. The CLI creates a storage zone for your files and a pull zone to serve them, then links this directory to the new site. The site is served at a b-cdn.net address, and the CLI prints the URL.

Build and deploy

bunny sites deploy --build

The CLI runs the build command, uploads the output directory from the table above, and publishes it. Every deploy is kept, so you can roll back with bunny sites deployments publish --previous.

Deploy on every push (optional)

bunny sites ci init

This writes a GitHub Actions workflow to .github/workflows/bunny-sites.yml that deploys the site on every push to main. Add your API key to the repository as a BUNNYNET_API_KEY secret. The CLI offers to run gh secret set BUNNYNET_API_KEY for you.

Build your site

From your project root, run npm run docs:build. The build writes your site to the output directory listed in the table above.

Create a storage zone

In the bunny.net dashboard, go to Storage and click Add Storage Zone. Give it a name, pick the main region closest to your audience, and click Add Storage Zone.

Upload your files

Open the storage zone’s file manager and upload the contents of your output directory to the root of the zone. To script uploads, use the Storage HTTP API.

Create a pull zone

Go to CDN and click Add Pull Zone. Set Origin Type to Storage Zone, select the zone you created, and click Add Pull Zone.Your site is live at https://<pull-zone-name>.b-cdn.net.

Add a custom domain

With the Bunny CLI, add the domain to your site:

bunny sites domains add example.com

The CLI prints the CNAME record to create with your DNS provider. Once the record resolves, issue a free certificate with bunny sites domains ssl example.com. For a manual deploy, add the hostname to your pull zone by following Custom hostnames.

Documentation

Features

Manage Files & Objects

Guides

Reference

Configure VitePress

Deploy your site

Add a custom domain

​Configure VitePress

​Deploy your site

​Add a custom domain

Configure VitePress

Deploy your site

Add a custom domain