@astrojs/ node
Questi contenuti non sono ancora disponibili nella tua lingua.
This adapter allows Astro to deploy your hybrid
or server
rendered site to Node targets.
If you’re using Astro as a static site builder, you don’t need an adapter.
Why Astro Node.js
Section titled Why Astro Node.jsNode.js is a JavaScript runtime for server-side code. @astrojs/node can be used either in standalone mode or as middleware for other http servers, such as Express.
Installation
Section titled InstallationAstro includes an astro add
command to automate the setup of official integrations. If you prefer, you can install integrations manually instead.
Add the Node adapter to enable SSR in your Astro project with the astro add
command.
This will install @astrojs/node
and make the appropriate changes to your astro.config.*
file in one step.
Manual Install
Section titled Manual InstallFirst, add the Node adapter to your project’s dependencies using your preferred package manager.
Then, add the adapter and your desired on-demand rendering mode to your astro.config.*
file:
Configuration
Section titled Configuration@astrojs/node can be configured by passing options into the adapter function. The following options are available:
Controls whether the adapter builds to middleware
or standalone
mode.
-
middleware
mode allows the built output to be used as middleware for another Node.js server, like Express.js or Fastify. -
standalone
mode builds to server that automatically starts with the entry module is run. This allows you to more easily deploy your build to a host without any additional code.
Middleware
Section titled MiddlewareAbility to pass middleware to be used only with standalone mode
. Gives you the ability to use packages such as http-proxy-middleware in standalone mode.
-
middleware
specify the filename thats going to export the one (or many combined) middleware. These middleware will be added when starting standalone server.
Usage
Section titled UsageFirst, performing a build. Depending on which mode
selected (see above) follow the appropriate steps below:
Middleware
Section titled MiddlewareThe server entrypoint is built to ./dist/server/entry.mjs
by default. This module exports a handler
function that can be used with any framework that supports the Node request
and response
objects.
For example, with Express:
Or, with Fastify (>4):
Additionally, you can also pass in an object to be accessed with Astro.locals
or in Astro middleware:
Note that middleware mode does not do file serving. You’ll need to configure your HTTP framework to do that for you. By default the client assets are written to ./dist/client/
.
Standalone
Section titled StandaloneIn standalone mode a server starts when the server entrypoint is run. By default it is built to ./dist/server/entry.mjs
. You can run it with:
For standalone mode the server handles file serving in addition to the page and API routes.
Custom host and port
Section titled Custom host and portYou can override the host and port the standalone server runs on by passing them as environment variables at runtime:
HTTPS
Section titled HTTPSBy default the standalone server uses HTTP. This works well if you have a proxy server in front of it that does HTTPS. If you need the standalone server to run HTTPS itself you need to provide your SSL key and certificate.
You can pass the path to your key and certification via the environment variables SERVER_CERT_PATH
and SERVER_KEY_PATH
. This is how you might pass them in bash:
Runtime environment variables
Section titled Runtime environment variablesIf an .env
file containing environment variables is present when the build process is run, these values will be hard-coded in the output, just as when generating a static website.
During the build, the runtime variables must be absent from the .env
file, and you must provide Astro with every environment variable to expect at run-time: VARIABLE_1=placeholder astro build
. This signals to Astro that the actual value will be available when the built application is run. The placeholder value will be ignored by the build process, and Astro will use the value provided at run-time.
In the case of multiple run-time variables, store them in a separate file (e.g. .env.runtime
) from .env
. Start the build with the following command:
Assets
Section titled AssetsIn standalone mode, assets in your dist/client/
folder are served via the standalone server. You might be deploying these assets to a CDN, in which case the server will never actually be serving them. But in some cases, such as intranet sites, it’s fine to serve static assets directly from the application server.
Assets in the dist/client/_astro/
folder are the ones that Astro has built. These assets are all named with a hash and therefore can be given long cache headers. Internally the adapter adds this header for these assets: