Platforms

Deploying to Netlify

Deploy your RivetKit app to [Netlify](https://netlify.com/).

Steps

Prerequisites

Netlify account
Your RivetKit app
- If you don’t have one, see the Quickstart page or our Examples
Access to the Rivet Cloud or a self-hosted Rivet Engine

Prepare Your Application

Make sure your project is configured correctly for Netlify deployment.

Your Hono project needs:

Install the Netlify Functions package:

npm install @netlify/functions

Command Line

A netlify.toml file with the functions and redirect configuration:

[build]
  command = "npm run build"
  publish = "public"
  functions = "functions"

[functions]
  node_bundler = "esbuild"

[[redirects]]
  from = "/api/rivet/*"
  to = "/.netlify/functions/rivet"
  status = 200

netlify.toml

A function handler that forwards requests to your Hono app:

import type { Handler } from "@netlify/functions";
import app from "../src/server.ts";

export const handler: Handler = async (event) => {
  const { httpMethod, path, queryStringParameters, headers, body } = event;

  const qs = queryStringParameters
    ? "?" + new URLSearchParams(queryStringParameters).toString()
    : "";
  const url = `https://${headers.host}${path}${qs}`;

  const request = new Request(url, {
    method: httpMethod,
    headers: headers as HeadersInit,
    body: body ? body : undefined,
  });

  const response = await app.fetch(request);

  const responseHeaders: Record<string, string> = {};
  response.headers.forEach((value, key) => {
    responseHeaders[key] = value;
  });

  return {
    statusCode: response.status,
    headers: responseHeaders,
    body: await response.text(),
  };
};

TypeScript

See the Hello World template for a complete example.

Your Next.js project should have the following structure:

src/app/api/rivet/[...all]/route.ts: RivetKit route handler
src/actors.ts: Actor definitions and registry

Configure your Next.js project for Netlify by installing the Netlify adapter:

npm install @netlify/plugin-nextjs

Command Line

Add a netlify.toml file:

[build]
  command = "npm run build"

[[plugins]]
  package = "@netlify/plugin-nextjs"

[functions]
  node_bundler = "esbuild"

netlify.toml

See the Next.js quickstart to get started with a Next.js + RivetKit app.

Deploy to Netlify

Connect your Git repository to Netlify:
- Visit Netlify and sign in
- Click “Add new site” > “Import an existing project”
- Connect your Git provider and select your repository
Configure build settings:
- Build command and publish directory are configured in your netlify.toml
Deploy your site:
- Netlify will automatically build and deploy your app
- You’ll receive a unique Netlify URL (e.g., https://amazing-app-123456.netlify.app)

More information on deployments is available in Netlify’s docs.

Set Environment Variables

In your Netlify site dashboard, go to Site settings > Environment variables
Add the following environment variables (provided after creating your project in the Rivet dashboard):
- RIVET_ENDPOINT: Your Rivet backend endpoint
- RIVET_PUBLIC_ENDPOINT: Your frontend-safe Rivet endpoint
Redeploy your site to apply the environment variables

See Netlify’s environment variables docs for more details.

Connect and Verify

Visit the Rivet dashboard
Navigate to Connect > Netlify
Skip to the Deploy to Netlify step
Input your deployed Netlify site URL
- e.g. https://amazing-app-123456.netlify.app/api/rivet
Once it shows as successfully connected, click Done

Your Netlify deployment is now connected to Rivet.