Skip to content

deno.mdx

Latest commit

 

History

History
365 lines (301 loc) · 9.94 KB

deno.mdx

File metadata and controls

365 lines (301 loc) · 9.94 KB
Raw
title Deploy your Astro Site with Deno
description How to deploy your Astro site to the web using Deno.
sidebar
label
Deno Deploy
type deploy
logo deno
supports
ssr
static
i18nReady true

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.

Requirements

This guide assumes you already have Deno installed.

Project Configuration

Your Astro project can be deployed as a static site, or as an on-demand rendered site.

Static 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.

Adapter for on-demand rendering

To enable on-demand rendering in your Astro project using Deno, and to deploy on Deno Deploy:

1. Install [the `@deno/astro-adapter` adapter][deno-adapter] to your project’s dependencies using your preferred package manager: ```shell npm install @deno/astro-adapter ``` ```shell pnpm install @deno/astro-adapter ``` ```shell yarn add @deno/astro-adapter ```

  1. 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(),
});

  2. 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.

    ```shell npm run preview ``` ```shell pnpm run preview ``` ```shell yarn run preview ```

How to deploy

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).

On your own server

1. Copy your project onto your server.

  1. Install the project dependencies using your preferred package manager:

    ```shell npm install ``` ```shell pnpm install ``` ```shell yarn install ```

  2. Build your Astro site with your preferred package manager:

    ```shell npm run build ``` ```shell pnpm run build ``` ```shell yarn run build ```

  3. Start your application with the following command:

    ```bash deno run -A jsr:@std/http/file-server dist ``` ```bash deno run -A ./dist/server/entry.mjs ```

GitHub Actions Deployment

If your project is stored on GitHub, the Deno Deploy website will guide you through setting up GitHub Actions to deploy your Astro site.

1. Push your code to a public or private GitHub repository.

  1. Sign in on Deno Deploy with your GitHub account, and click on New Project.

  2. 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.)

  3. 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.

    ```yaml --- // .github/workflows/deploy.yml --- name: Deploy on: [push] 
     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@v7

       # Not using npm? Change `npm ci` to `pnpm i` or `yarn install`
       - name: Install dependencies
         run: npm ci

       # Not using npm? Change `npm run build` to `pnpm run build` or `yarn 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
 ```
    ```yaml --- // .github/workflows/deploy.yml --- name: Deploy on: [push] 
     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@v7

       # Not using npm? Change `npm ci` to `pnpm i` or `yarn install`
       - name: Install dependencies
         run: npm ci

       # Not using npm? Change `npm run build` to `pnpm run build` or `yarn 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
 ```

  4. 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.

CLI Deployment

1. Install the [Deno Deploy CLI](https://docs.deno.com/deploy/manual/deployctl). 
```bash
deno install -gArf jsr:@deno/deployctl
```

  1. Build your Astro site with your preferred package manager:

    ```shell npm run build ``` ```shell pnpm run build ``` ```shell yarn run build ```

  2. Run deployctl to deploy!

    ```bash cd dist && deployctl deploy jsr:@std/http/file-server ``` ```bash deployctl deploy ./dist/server/entry.mjs ```

    You can track all your deploys on Deno Deploy.

  3. (Optional) To simplify the build and deploy into one command, add a deploy-deno script in package.json, adapting it for your preferred package manager.

    ```json ins={8} // package.json { "scripts": { "dev": "astro dev", "start": "astro dev", "build": "astro build", "preview": "astro preview", "deno-deploy": "npm run build && cd dist && deployctl deploy jsr:@std/http/file-server" } } ``` ```json ins={8} // package.json { "scripts": { "dev": "astro dev", "start": "astro dev", "build": "astro build", "preview": "deno run --allow-net --allow-read --allow-env ./dist/server/entry.mjs", "deno-deploy": "npm run build && deployctl deploy ./dist/server/entry.mjs" } } ```

    Then you can use this command to build and deploy your Astro site in one step.

    ```shell npm run deno-deploy ``` ```shell pnpm run deno-deploy ``` ```shell yarn run deno-deploy ```