Skip to content

add dynamic base URL config for Zola preview deployments #21999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: production
Choose a base branch
from
Open

add dynamic base URL config for Zola preview deployments #21999

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac8848c
add dynamic base URL config for Zola preview deployments
welpo Apr 26, 2025
0b8a386
use config.toml base_url
welpo Apr 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/content/docs/pages/framework-guides/deploy-a-zola-site.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,18 @@ base_url = "https://my-zola-project.pages.dev"

Every time you commit new code to your Zola site, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to [preview deployments](/pages/configuration/preview-deployments/) on new pull requests, so you can preview how changes look to your site before deploying them to production.

### Handling Preview Deployments

When working with Cloudflare Pages, you'll often use preview deployments for testing changes before merging to your main branch. However, these preview deployments use different URLs (like `https://your-branch-name.my-zola-project.pages.dev`), which can cause issues with asset loading if your `base_url` is hardcoded.

To fix this, modify your build command in the Cloudflare Pages configuration to dynamically set the base URL depending on the environment:

```sh
if [ "$CF_PAGES_BRANCH" = "main" ]; then zola build; else zola build --base-url $CF_PAGES_URL; fi
```

This command uses:
- The `base_url` set in `config.toml` when building from the `main` branch
- The preview deployment URL (automatically provided by Cloudflare Pages as `$CF_PAGES_URL`) for all other branches

<Render file="framework-guides/learn-more" params={{ one: "Zola" }} />