src/content/docs/en/guides/deploy/deno.mdx
import { Steps } from '@astrojs/starlight/components';
import StaticSsrTabs from '/components/tabs/StaticSsrTabs.astro';
import PackageManagerTabs from '/components/tabs/PackageManagerTabs.astro'
You can deploy a static or on-demand rendered Astro site using Deno, either on your own server, or to Deno Deploy, a distributed system that runs JavaScript, TypeScript, and WebAssembly at the edge, worldwide.
This guide includes instructions for running your Astro site on your own server with Deno, and deploying to Deno Deploy through GitHub Actions or the Deno Deploy CLI.
This guide assumes you already have Deno installed.
Your Astro project can be deployed as a static site, or as an on-demand rendered site.
Your Astro project is a static site by default. You don’t need any extra configuration to deploy a static Astro site with Deno, or to Deno Deploy.
To enable on-demand rendering in your Astro project using Deno, and to deploy on Deno Deploy:
<Steps> 1. Install [the `@deno/astro-adapter` adapter][Deno adapter] to your project’s dependencies using your preferred package manager: <PackageManagerTabs> <Fragment slot="npm"> ```shell npm install @deno/astro-adapter ``` </Fragment> <Fragment slot="pnpm"> ```shell pnpm install @deno/astro-adapter ``` </Fragment> <Fragment slot="yarn"> ```shell yarn add @deno/astro-adapter ``` </Fragment> </PackageManagerTabs>Update your astro.config.mjs project configuration file with the changes below.
// astro.config.mjs
import { defineConfig } from 'astro/config';
import deno from '@deno/astro-adapter';
export default defineConfig({
output: 'server',
adapter: deno(),
});
Update your preview script in package.json with the change below.
// package.json
{
// ...
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview"
"preview": "deno run --allow-net --allow-read --allow-env ./dist/server/entry.mjs"
}
}
You can now use this command to preview your production Astro site locally with Deno.
<PackageManagerTabs> <Fragment slot="npm"> ```shell npm run preview ``` </Fragment> <Fragment slot="pnpm"> ```shell pnpm run preview ``` </Fragment> <Fragment slot="yarn"> ```shell yarn run preview ``` </Fragment> </PackageManagerTabs>You can run your Astro site on your own server, or deploy to Deno Deploy through GitHub Actions or using Deno Deploy’s CLI (command line interface).
Install the project dependencies using your preferred package manager:
<PackageManagerTabs> <Fragment slot="npm"> ```shell npm install ``` </Fragment> <Fragment slot="pnpm"> ```shell pnpm install ``` </Fragment> <Fragment slot="yarn"> ```shell yarn ``` </Fragment> </PackageManagerTabs>Build your Astro site with your preferred package manager:
<PackageManagerTabs> <Fragment slot="npm"> ```shell npm run build ``` </Fragment> <Fragment slot="pnpm"> ```shell pnpm run build ``` </Fragment> <Fragment slot="yarn"> ```shell yarn run build ``` </Fragment> </PackageManagerTabs>Start your application with the following command:
<StaticSsrTabs> <Fragment slot="static"> ```bash deno run -A jsr:@std/http/file-server dist ``` </Fragment> <Fragment slot="ssr"> ```bash deno run -A ./dist/server/entry.mjs ``` </Fragment> </StaticSsrTabs>If your project is stored on GitHub, the Deno Deploy website will guide you through setting up GitHub Actions to deploy your Astro site.
<Steps> 1. Push your code to a public or private GitHub repository.Sign in on Deno Deploy with your GitHub account, and click on New Project.
Select your repository, the branch you want to deploy from, and select GitHub Action mode. (Your Astro site requires a build step, and cannot use Automatic mode.)
In your Astro project, create a new file at .github/workflows/deploy.yml and paste in the YAML below. This is similar to the YAML given by Deno Deploy, with the additional steps needed for your Astro site.
jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
permissions:
id-token: write # Needed for auth with Deno Deploy
contents: read # Needed to clone the repository
steps:
- name: Clone repository
uses: actions/checkout@v4
# Not using npm? Change `npm ci` to `yarn install` or `pnpm i`
- name: Install dependencies
run: npm ci
# Not using npm? Change `npm run build` to `yarn build` or `pnpm run build`
- name: Build Astro
run: npm run build
- name: Upload to Deno Deploy
uses: denoland/deployctl@v1
with:
project: my-deno-project # TODO: replace with Deno Deploy project name
entrypoint: jsr:@std/http/file-server
root: dist
```
jobs:
deploy:
name: Deploy
runs-on: ubuntu-latest
permissions:
id-token: write # Needed for auth with Deno Deploy
contents: read # Needed to clone the repository
steps:
- name: Clone repository
uses: actions/checkout@v4
# Not using npm? Change `npm ci` to `yarn install` or `pnpm i`
- name: Install dependencies
run: npm ci
# Not using npm? Change `npm run build` to `yarn build` or `pnpm run build`
- name: Build Astro
run: npm run build
- name: Upload to Deno Deploy
uses: denoland/deployctl@v1
with:
project: my-deno-project # TODO: replace with Deno Deploy project name
entrypoint: dist/server/entry.mjs
```
After committing this YAML file, and pushing to GitHub on your configured deploy branch, the deploy should begin automatically!
You can track the progress using the "Actions" tab on your GitHub repository page, or on Deno Deploy.
</Steps>```bash
deno install -gArf jsr:@deno/deployctl
```
2. Build your Astro site with your preferred package manager:
<PackageManagerTabs> <Fragment slot="npm"> ```shell npm run build ``` </Fragment> <Fragment slot="pnpm"> ```shell pnpm run build ``` </Fragment> <Fragment slot="yarn"> ```shell yarn run build ``` </Fragment> </PackageManagerTabs>Run deployctl to deploy!
You can track all your deploys on Deno Deploy.
(Optional) To simplify the build and deploy into one command, add a deploy-deno script in package.json.
Then you can use this command to build and deploy your Astro site in one step.
npm run deno-deploy