Skip to content

Add headers and redirects section to Vite plugin docs #21504

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

Merged
merged 2 commits into from
Apr 8, 2025
Merged

Add headers and redirects section to Vite plugin docs #21504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7cf64e
Add note about auxiliary Workers and React Router
jamesopstad Apr 8, 2025
d536211
Add headers and redirects section to Static Assets
jamesopstad Apr 8, 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: 9 additions & 5 deletions src/content/docs/workers/vite-plugin/reference/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,15 @@ It accepts an optional `PluginConfig` parameter.
All requests are routed through your entry Worker.
During the build, each Worker is output to a separate subdirectory of `dist`.

:::note
When running `wrangler deploy`, only your main (entry) Worker will be deployed.
If using multiple Workers, each auxiliary Worker must be deployed individually.
You can inspect the `dist` directory and then run `wrangler deploy -c dist/<auxiliary-worker>/wrangler.json` for each.
:::
:::note
Auxiliary Workers are not currently supported when using [React Router](https://reactrouter.com/) as a framework.
:::

:::note
When running `wrangler deploy`, only your main (entry) Worker will be deployed.
If using multiple Workers, each auxiliary Worker must be deployed individually.
You can inspect the `dist` directory and then run `wrangler deploy -c dist/<auxiliary-worker>/wrangler.json` for each.
:::

## `interface AuxiliaryWorkerConfig`

Expand Down
8 changes: 7 additions & 1 deletion src/content/docs/workers/vite-plugin/reference/static-assets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,13 @@ assets = { not_found_handling = "single-page-application" }

</WranglerConfig>

{/* Add docs for _headers and _redirects */}
## Headers and redirects

Custom [headers](/workers/static-assets/headers/) and [redirects](/workers/static-assets/redirects/) are supported at build, preview and deploy time by adding `_headers` and `_redirects` files to your [`public` directory](https://vite.dev/guide/assets#the-public-directory).
The paths in these files should reflect the structure of your client build output.
For example, generated assets are typically located in an [assets subdirectory](https://vite.dev/config/build-options#build-assetsdir).

<br />

:::note
The Cloudflare Vite plugin does not support [run_worker_first](/workers/static-assets/binding/#run_worker_first).
Expand Down