Skip to content
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.

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

Add more information about Vercel deployments #2399

Merged
merged 3 commits into from
Jan 7, 2024
Merged
Changes from 2 commits
Commits
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
82 changes: 82 additions & 0 deletions docs/content/documentation/deployment/vercel.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,85 @@ You can learn more about how to setup a custom domain and how to get the most ou
[via their documentation.](https://vercel.com/docs)

After you click the blue "Deploy" button, it's off to the races!

To use a specific version of Zola, set [`ZOLA_VERSION`](https://vercel.com/docs/deployments/environments#specifying-framework-versions) environment variable in project settings to a valid
release tag, for example `0.17.2`.

## Troubleshooting

### `GLIBC_X.XX` not found

This is because Vercel's build images comes with an older glibc version whereas Zola
depends on a newer glibc. However, Vercel provides a newer build image which can be used in
deployments by setting Node.js version to "20.x", allowing Zola to work properly.

## Additional options

### Enable trailing slashes

Visiting a page without trailing slash may break relative paths, so you might want to configure
Vercel to always redirect paths with a trailing slash. By default, redirecting to a trailing
slash is not enabled on Vercel.

For example if you have an `about.md` file, and when visiting the path without a trailing
slash, like `/about`, Vercel will redirect with trailing slash, resulting in `/about/`.
Paths with a file extension will not redirect to a trailing slash, for example if you
have a static file named `favicon.ico`, it will stay as-is.

To enable that, create a file in the root of your git repository named `vercel.json`
(if it doesn't exists already), and set this option:

```json
{
"trailingSlash": true
}
```

### Prefer clean URLs

When enabled, all HTML files will be served without their file extension. For example
if you have an `about.md` file, Zola will generate a `about.html` file, but Vercel
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zola will generate a about.html

No, Zola will generate about/index.html

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it was an oversight on my part, I forgot how it works for a moment 😅 Fixed.

will serve the file as `/about`, without its `.html` suffix.

To enable that, create a file in the root of your git repository named `vercel.json`
(if it doesn't exists already), and set this option:

```json
{
"cleanUrls": true
}
```

### Using a custom Zola binary

If you want to use your own Zola binary that published on GitHub, or if you want to
always use the latest version of Zola, you can run a shell command to grab the
latest release from GitHub.

To do that, set "Framework Preset" to "Other", and override "Install Command" to:

```bash
REPO="getzola/zola"; curl -fsS https://api.github.com/repos/${REPO}/releases/latest | grep -oP '"browser_download_url": ?"\K(.+linux-gnu.tar.gz)' | xargs -n 1 curl -fsSL -o zola.tar.gz && tar -xzvf zola.tar.gz
```

This command will fetch the latest release from GitHub, download the archive and extract it.

Then, set "Build Command" to `./zola build`. Now Vercel will use the downloaded Zola
binary to build the documentation instead of using the built-in one.

If you prefer to use `vercel.json` instead, (which overrides the options set in the dashboard)
you can use this configuration.

```json
{
"framework": null,
"installCommand": "REPO=\"getzola/zola\"; curl -fsS https://api.github.com/repos/${REPO}/releases/latest | grep -oP '\"browser_download_url\": ?\"\\K(.+linux-gnu.tar.gz)' | xargs -n 1 curl -fsSL -o zola.tar.gz && tar -xzvf zola.tar.gz",
"buildCommand": "./zola build",
"outputDirectory": "public"
}
```

## See also

See [Vercel's own documentation](https://vercel.com/docs/projects/project-configuration)
for all available options in `vercel.json`.