Northflank is a PaaS that allows you to run persistent sandboxes either on the Northflank infrastructure or your GCP/AWS. You can read more about it here.

How to use

To use Northflank with VibeKit, you need to configure Northflank when creating a new VibeKit instance. Note that you must create a new project and API key in the Northflank dashboard.

import { VibeKit, VibeConfig } from "@vibe-kit/sdk";

const config: VibeConfig = {
  ...,
  environment: {
    northflank: {
      // Required Northflank API key
      apiKey: "nf_****",
      // Optional custom image to override the inferred agent sandbox image
      image: "your-custom-image",
      // Optional project ID corresponding to the project you created
      projectId: "your-project-id",
      // Optional billing plan determining CPU & RAM (default: nf-compute-200 - 2 vCPU & 4096GB RAM)
      billingPlan: "nf-compute-200",
      // Optional persistent path of your sandbox (default: /var/app)
      persistentVolume: "/var/app",
      // Optional persistent volume size in MB (default: 10240 - 10GiB)
      persistentVolumeStorage: 10240
    },
  },
};

Configuration Options

  • apiKey (required): The API token you generated in the Northflank dashboard for authentication
  • image (optional): Override the inferred agent sandbox image with a custom image
  • projectId (optional): The project name you created in the Northflank dashboard
  • billingPlan (optional): Determines the CPU & RAM of the sandboxes (default: nf-compute-200 which has 2 vCPU & 4096GB RAM)
  • persistentVolume (optional): The persistent path of your sandbox (default: /var/app)
  • persistentVolumeStorage (optional): The persistent volume size in MB (default: 10240 for 10GiB)

ENV variables and secrets

Coming soon…