Add server.headers option
#5564
Conversation
🦋 Changeset detectedLatest commit: 121ed37 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
riywo
force-pushed
the
feature/server.headers
branch
from
22c34bc
to
a34a19e
Compare
| // Set user specified headers to response object. | ||
| for (const [name, value] of Object.entries(config.server.headers ?? {})) { | ||
| if (value) res.setHeader(name, value); | ||
| } | ||
|
|
There was a problem hiding this comment.
I'm not sure why but passing server.headers to vite config didn't work. Hence, writing the headers here directly.
|
Can anyone rerun the failed job? It failed at post steps, so it actually succeeded. https://github.com/withastro/astro/actions/runs/3654029967/jobs/6174109857 |
|
Thank you for kicking a retry. Now all checks have passed. It would be great if someone can review and merge this change. I'd like to build a website using |
|
Hmm, checking this patch with a real environment but it doesn't seem working. Will update. |
With this new `server.headers` option, the users can specify custom headers for `astro dev` and `astro preview` servers. This is useful when they want to build a website requiring specific response headers such as `Cross-Origin-Opener-Policy`.
riywo
force-pushed
the
feature/server.headers
branch
from
a34a19e
to
121ed37
Compare
|
Done. This patch was needed when invoked from CLI actually. https://github.com/withastro/astro/compare/a34a19e8c92b5fcb92fe2651369e68465f090405..121ed37bdde07213628d9347405581d0c5a187c8 Not sure we should add such unit tests (or E2E tests?), though. |
|
I think this is good since this is done manually. In production you'll have to make sure your server is configured to do the same, but I think given this is an opt-in approach that becomes obvious. |
With this new
server.headersoption, the users can specify custom headers forastro devandastro previewservers.This is useful when they want to build a website requiring specific response headers such as
Cross-Origin-Opener-Policy.Changes
Adding a new
server.headersoption to allow the users to specify HTTP response headers for bothastro devandastro preview.Testing
Added new unit tests for both
astro devandastro preview.Docs
This document should be updated: https://docs.astro.build/en/reference/configuration-reference/#server-options