Deno Deploy

Deploy your Restate services on Deno Deploy. This guide covers project configuration, service registration, and security setup.

Follow the quickstart to try Deno and Restate locally.

Deploying to Deno Deploy

Set up your project

New project
Existing Deno project

Start from the Deno template:

Import the Restate SDK with the fetch component:

import * as restate from "@restatedev/restate-sdk/fetch";

// Create the Restate endpoint
// Here you need to register your services
const handler = restate.createEndpointHandler({
    services: [greeter],
    bidirectional: true,
});

// Serve using Deno
Deno.serve({ port: 9080 }, handler);

Secure your service with request identity validation

Deno Deploy services are public HTTP endpoints. Secure your service with request identity validation so that it only accepts requests from the Restate environment you trust.

Restate Cloud / BYOC
Restate OSS

Restate Cloud and BYOC environments create and manage the request identity key for you.Copy the environment’s public key from Developers > Security > HTTP endpoints in the Restate Cloud UI.

Request identity uses an ED25519 key pair. Give the private key to Restate so it can sign requests, and give the public key to your services so they can verify those signatures.Choose one of the following ways to generate the keys:

Option 1: Let Restate output the public key

Generate the private key:

openssl genpkey -algorithm ed25519 -outform pem -out private.pem

Provide its path to Restate on startup:

export RESTATE_REQUEST_IDENTITY_PRIVATE_KEY_PEM_FILE=private.pem

Start Restate and copy the corresponding public key from the startup log. Restate prints it in the compact format expected by the SDK:

INFO restate_service_client::request_identity::v1
Loaded request identity key
kid: "publickeyv1_w7YHemBctH5Ck2nQRQ47iBBqhNHy4FV7t2Usbye2A6f"
path: private.pem

Option 2: Generate both key files beforehand

Run this script to generate private.pem and write the corresponding publickeyv1_... value to a public-key file before starting Restate:

macOS
Linux

Install OpenSSL 3 with Homebrew, then run the script:

brew install openssl@3

generate.sh

#!/usr/bin/env bash
set -euo pipefail

openssl_bin="$(brew --prefix openssl@3)/bin/openssl"

# generate private key
"$openssl_bin" genpkey -algorithm ed25519 -outform pem -out private.pem
echo "Wrote private key to private.pem"

# encode public key
encoded=$("$openssl_bin" pkey -in private.pem -pubout -outform DER 2>/dev/null |
tail -c +13 |
od -An -v -tu1 |
awk '
BEGIN {
  alphabet = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
  leading = 1
}
{
  for (i = 1; i <= NF; i++) {
    byte = $i
    if (leading && byte == 0) {
      zeroes++
      continue
    }
    leading = 0
    carry = byte
    for (j = 0; j < digit_count; j++) {
      carry += digits[j] * 256
      digits[j] = carry % 58
      carry = int(carry / 58)
    }
    while (carry > 0) {
      digits[digit_count++] = carry % 58
      carry = int(carry / 58)
    }
  }
}
END {
  for (i = 0; i < zeroes; i++) printf "1"
  for (i = digit_count - 1; i >= 0; i--) {
    printf "%s", substr(alphabet, digits[i] + 1, 1)
  }
}')

echo -n "publickeyv1_${encoded}" > public-key
echo "Wrote publickeyv1_${encoded} to public-key"

This script requires Bash, OpenSSL, awk, and GNU Coreutils:

generate.sh

#!/usr/bin/env bash
set -euo pipefail

# generate private key
openssl genpkey -algorithm ed25519 -outform pem -out private.pem
echo "Wrote private key to private.pem"

base58_chars="123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
# encode public key
encoded=$(openssl ec -in private.pem -inform pem -pubout -outform der -out /dev/stdout 2>/dev/null |
tail -c +13 |
basenc --base16 "${1:-/dev/stdin}" -w0 |
if
read
[[ $REPLY =~ ^((00)*)(([[:xdigit:]]{2})*) ]]
echo -n "${BASH_REMATCH[1]//00/1}" # leading 0s -> 1
(( ${#BASH_REMATCH[3]} > 0 ))
then
dc -e "16i0${BASH_REMATCH[3]^^} Ai[58~rd0<x]dsxx+f" | # hex bytes to indexes into the char string
while read -r
do echo -n "${base58_chars:REPLY:1}"
done
fi)

echo -n "publickeyv1_${encoded}" > public-key
echo "Wrote publickeyv1_${encoded} to public-key"

Configure the key in your Restate SDK endpoint before deploying.

const handler = restate.createEndpointHandler({
  services: [myService],
  identityKeys: ["publickeyv1_w7YHemBctH5Ck2nQRQ47iBBqhNHy4FV7t2Usbye2A6f"],
});

The public key is not secret, so it is safe to include it directly in your service source code or configuration files.

Register the service to Restate

Once deployed on Deno Deploy EA, use Preview URLs so that Restate can target specific service versions.

Restate Cloud / BYOC
Restate OSS

Or register the service with the CLI:

npx @restatedev/restate deployments register \
  https://your-project-name-<deployment_id>.deno.dev

Send your first request

Restate Cloud / BYOC
Restate OSS

You’re set up! Go to the Overview page > Greeter > Playground and start sending requests to your service.

CI/CD Automation

You can set up automation to register new Restate service versions every time you deploy to Deno Deploy:

If you’ve followed the steps above, then you already have the GitHub Actions workflow set up. All you need to do is to add the secrets below to your project.

Create the project in the Deno console before the first workflow run.

Restate Cloud / BYOC
Restate OSS

.github/workflows/deploy.yml

name: Register to Restate

on:
  repository_dispatch:
    types: [deno_deploy.build.routed]

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Register Restate deployment
        env:
          RESTATE_ADMIN_URL: ${{ secrets.RESTATE_ADMIN_URL }}
          RESTATE_AUTH_TOKEN: ${{ secrets.RESTATE_AUTH_TOKEN }}
        run: npx -y @restatedev/restate deployment register -y ${{ github.event.client_payload.revision.preview_url }}

This workflow needs the following GitHub Actions repository secrets:

RESTATE_ADMIN_URL: The Admin URL. You can find it in Developers > Admin URL
RESTATE_AUTH_TOKEN: Your Restate Cloud or BYOC auth token. To get one, go to Developers > API Keys > Create API Key, and make sure to select Admin for the role
View

.github/workflows/deploy.yml

name: Register to Restate

on:
  repository_dispatch:
    types: [deno_deploy.build.routed]

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Register Restate deployment
        env:
          RESTATE_ADMIN_URL: ${{ secrets.RESTATE_ADMIN_URL }}
          RESTATE_AUTH_TOKEN: ${{ secrets.RESTATE_AUTH_TOKEN }}
        run: npx -y @restatedev/restate deployment register -y ${{ github.event.client_payload.revision.preview_url }}

This workflow needs the following GitHub Actions repository secrets:

RESTATE_ADMIN_URL: The URL through which GitHub Actions can reach your Restate Admin API
RESTATE_AUTH_TOKEN: Set this token if GitHub Actions reaches the Admin API through a reverse proxy that accepts bearer token authentication

Deno Deploy Classic

For Deno Deploy Classic, we suggest the following CI/CD setup that deploys to Deno and then registers the deployment with Restate:Configure RESTATE_ADMIN_URL and RESTATE_AUTH_TOKEN as described above for your Restate environment.

name: Deploy Deno

on:
  push:
    branches:
      - main

env:
  # Create the Deno project going to https://dash.deno.com/new_project linking this repository.
  # When creating the project, check **Just link the repo, I’ll set up GitHub Actions myself**.
  # Make sure this project name matches the deno project.
  DENO_PROJECT_NAME: ${{ vars.DENO_PROJECT_NAME }}

jobs:
  deploy:
    permissions:
      id-token: write # required
      contents: read
    runs-on: ubuntu-latest
    timeout-minutes: 60
    steps:
      - uses: actions/checkout@v4
      - uses: denoland/setup-deno@v2
        with:
          deno-version: v2.x

      # Deploy using deployctl
      - name: Deploy to Deno Deploy
        uses: denoland/deployctl@v1
        id: deploy
        with:
          project: ${{ env.DENO_PROJECT_NAME }}
          entrypoint: main.ts

      - name: Register Restate deployment
        env:
          RESTATE_ADMIN_URL: ${{ secrets.RESTATE_ADMIN_URL }}
          RESTATE_AUTH_TOKEN: ${{ secrets.RESTATE_AUTH_TOKEN }}
        # Revision URL https://docs.deno.com/deploy/classic/deployments/#production-vs.-preview-deployments
        run: npx -y @restatedev/restate deployment register -y https://${{ env.DENO_PROJECT_NAME }}-${{ steps.deploy.outputs.deployment-id }}.deno.dev

SDKs

Services

Restate Cloud / BYOC / OSS

References

Deploying to Deno Deploy

Set up your project

Secure your service with request identity validation

Register the service to Restate

Send your first request

CI/CD Automation

​Deploying to Deno Deploy

Set up your project

Secure your service with request identity validation

Register the service to Restate

Send your first request

​CI/CD Automation

Deploying to Deno Deploy

CI/CD Automation