How to run a Upstash sandbox

You can clone this repo and update your credentials to run locally.

Upstash Box provides cloud sandboxes with two variants: a full-featured Default Box, and a lightweight Ephemeral Box for short-lived tasks. Let’s walk through the process of getting a basic application running inside a Upstash sandbox.

Why use Upstash as your sandbox provider?

Two box types: a full-featured Default Box (filesystem, shell, snapshots, preview URLs), or a lightweight Ephemeral Box for short-lived, one-off tasks.
Backed by Upstash’s existing developer platform, so it’s an easy add if you already use Upstash.
A single API key is all you need to get started.

Let’s see how we can easily run a basic Vite app inside of a Upstash sandbox.

Let’s start by creating a new Next.js project

Run this command in your terminal:

npx create-next-app@latest upstash-basic

You can use all of the defaults when prompted.

Create an .env file

Once it has been created, be sure to create an .env file to add your necessary credentials to.

UPSTASH_BOX_API_KEY=your_upstash_box_api_key

Install ComputeSDK and the Upstash provider

ComputeSDK ships as a small core package plus one package per provider, so you only install what you use.

cd upstash-basic
npm install computesdk @computesdk/upstash

Create or log in to your Upstash account

Create a Upstash account or log in here.
Create an account, then generate an API key from your Upstash console under Box.

Save these values in your .env file.

UPSTASH_BOX_API_KEY=your_upstash_box_api_key

Now we’ll move on to creating the actual sandbox logic

We need to create the API route to create the sandbox

Import the upstash factory from @computesdk/upstash and pass it your credentials. compute.sandbox.create() provisions a sandbox on Upstash.
Create a new route.ts file in app/api/sandbox and paste the following code:

// app/api/sandbox/route.ts
import { NextResponse } from 'next/server';
import { upstash } from '@computesdk/upstash';

const compute = upstash({
  apiKey: process.env.UPSTASH_BOX_API_KEY,
});

export async function POST() {

  const sandbox = await compute.sandbox.create();

  return NextResponse.json({
    sandboxId: sandbox.sandboxId,
  });
}

Next, we’ll edit the page.tsx file

We’ll keep it simple and just add one button to run our sandbox test with.
Replace the content on Page.tsx with this code:

// app/page.tsx
'use client';

export default function Home() {
  const createSandbox = async () => {
    const res = await fetch('/api/sandbox', { method: 'POST' });
    const data = await res.json();
    console.log(data);
  };

  return (
    <div className="flex min-h-screen flex-col items-center justify-center p-24">
      <h1 className="mb-8 text-4xl font-bold">ComputeSDK Sandbox Test</h1>
      <button
        className="rounded bg-blue-500 px-4 py-2 font-bold text-white hover:bg-blue-700"
        type="button"
        onClick={createSandbox}
      >
        Create Upstash sandbox
      </button>
    </div>
  );
}

Now, our first test

Run npm run dev in your terminal to start the dev server.
Open localhost:3000
Click the button on the main page.

Then check your Upstash console.
You should see a new sandbox created!

Success!

You’ve successfully created your first Upstash sandbox

If you want to use another sandbox provider like E2B or Daytona, swap the import and factory call — install @computesdk/e2b and use import { e2b } from '@computesdk/e2b' instead, with that provider’s own credentials. The rest of your code (runCommand, filesystem, getUrl) stays the same — that’s the point of the universal Sandbox interface.

Making changes within the sandbox

Now, let’s take the next step and run a primitive Vite app inside of our sandbox as an example of what we are able to do within the sandbox itself.

Update /api/sandbox/route.ts

Add the following to your app/api/sandbox/route.ts file directly below this in your code:

const sandbox = await compute.sandbox.create();

Create a basic Vite app inside our sandbox subfolder

// Scaffold Vite React app
await sandbox.runCommand('npm create vite@5 app -- --template react');

Use the writeFile method

Customize the vite.config.js so we can access the local dev server.

// Custom vite.config.js to allow access to sandbox at port 5173
  const viteConfig = `import { defineConfig } from 'vite'
  import react from '@vitejs/plugin-react'

  export default defineConfig({
    plugins: [react()],
    server: {
      host: '0.0.0.0',
      port: 5173,
      strictPort: true,
      hmr: false,
      allowedHosts: ['.preview.box.upstash.com', 'localhost', '127.0.0.1'],
    },
  })
  `;
  await sandbox.filesystem.writeFile('app/vite.config.js', viteConfig);

Run npm install using the runCommand method

  // Install dependencies
  await sandbox.runCommand('npm install', {
    cwd: 'app',
  })

Start local dev server in the background with runCommand

  // Start dev server
  sandbox.runCommand('npm run dev', {
    cwd: 'app',
  });

Use the getUrl method to get a preview URL

  // Get preview URL
  const url = await sandbox.getUrl({ port: 5173 });
  console.log('previewUrl:', url)

Upstash’s Default Box preview URLs follow the pattern https://<box-id>-<port>.preview.box.upstash.com (Ephemeral Boxes don’t support preview URLs at all) — an Upstash domain, not a shared ComputeSDK one.

Return the preview url along with the sandboxId

  return NextResponse.json({
    sandboxId: sandbox.sandboxId,
    url,
  });

Finished route.ts file

Your /app/api/sandbox/route.ts file should look like this now:

import { NextResponse } from 'next/server';
import { upstash } from '@computesdk/upstash';

const compute = upstash({
  apiKey: process.env.UPSTASH_BOX_API_KEY,
});

export async function POST() {

  const sandbox = await compute.sandbox.create();

  // Create basic Vite React app
  await sandbox.runCommand('npm create vite@5 app -- --template react');

  // Custom vite.config.js to allow access to sandbox at port 5173
  const viteConfig = `import { defineConfig } from 'vite'
  import react from '@vitejs/plugin-react'

  export default defineConfig({
    plugins: [react()],
    server: {
      host: '0.0.0.0',
      port: 5173,
      strictPort: true,
      hmr: false,
      allowedHosts: ['.preview.box.upstash.com', 'localhost', '127.0.0.1'],
    },
  })
  `;
  await sandbox.filesystem.writeFile('app/vite.config.js', viteConfig);

  // Install dependencies
  await sandbox.runCommand('npm install', {
    cwd: 'app',
  })

  // Start dev server
  sandbox.runCommand('npm run dev', {
    cwd: 'app',
  });

  // Get preview URL
  const url = await sandbox.getUrl({ port: 5173 });
  console.log('previewUrl:', url)

  return NextResponse.json({
    sandboxId: sandbox.sandboxId,
    url,
  });
}

Testing Vite app inside sandbox

Now, after you click the “Create Upstash Sandbox” button on your localhost homepage you should:

See a new sandbox created in your Upstash console.
See a preview URL logged to your terminal output.
Finally, if you visit that URL you should see the boilerplate Vite React app running in your Upstash sandbox!

screenshot of Vite app running in Upstash sandbox via ComputeSDK

Congrats! You’ve successfully created your first sandbox application

You have done the following:

created a Upstash sandbox with ComputeSDK
used our runCommand, writeFile, and getUrl methods (these work with any provider whose sandbox supports them)
ran a Vite app inside the sandbox
accessed the app running within the sandbox through its preview URL

ComputeSDK makes it easy to standardize this process across providers.
So now that you’ve written this code for Upstash, you can easily adjust this code to run in any sandbox provider.

Happy Sandboxing!

Want to get sandboxes running in your application?
Want to be added as a provider?
Reach out to us at [email protected]