---
title: "boot"
source: "https://browserpod.io/docs/reference/BrowserPod/boot"
---

# boot

Boot a BrowserPod Pod to start an isolated, in-browser Linux runtime, optionally persisting its filesystem with a storageKey.

```ts
class BrowserPod {
  static async boot(opts?: {
    apiKey?: string;
    network?: PodNetwork;
    nodeVersion?: string;
    storageKey?: string;
    userImage?: string;
  }): Promise<BrowserPod>;
}
```

## Parameters

- **opts (object, _optional_)** - Initialization options passed as an object.

## Options

- **apiKey (`string`, _optional_)** - The [API key](https://browserpod.io/docs/understanding-browserpod/api-key.md) used to connect the Pod to the [Edge network](https://browserpod.io/docs/understanding-browserpod/networking.md).
  - _Omitted_ → The Pod boots on a free [fetch network](https://browserpod.io/docs/understanding-browserpod/networking.md), routing requests directly through the browser.

- **network (`PodNetwork`, _optional_)** - A preconfigured network instance created with [`createEdgeNetwork`](https://browserpod.io/docs/reference/BrowserPod/createEdgeNetwork.md) or [`createFetchNetwork`](https://browserpod.io/docs/reference/BrowserPod/createFetchNetwork.md). Cannot be combined with `apiKey`; pass the key to `createEdgeNetwork` instead. Create a new network for each Pod: booting a second Pod with the same network throws.

- **nodeVersion (`string`, _optional_)** - The version of Node.js to use. Currently only “22” is allowed.

- **storageKey (`string`, _optional_)** - Identifies the Pod’s persistent storage.

  - _Omitted_ → ephemeral: fresh disk each boot, nothing is saved between sessions.
  - _Provided_ → persistent: the same key resumes the same disk, a different key starts a separate one.

- **userImage (`string`, _optional_)** - A URL pointing to a custom ext2 filesystem image that will be mounted directly on the `/home` directory of the Pod’s filesystem. If you change the image, also change the `storageKey` if provided.

## Returns

`boot` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which is resolved when the [Pod](https://browserpod.io/docs/reference/BrowserPod.md) is ready to be used. It returns the newly created [Pod](https://browserpod.io/docs/reference/BrowserPod.md).

## Notes

- The Edge network is charged in one-hour blocks of 10 tokens ($0.01), deducted from your BrowserPod account balance: one block at boot, and another for each further hour, or part of an hour, that the Pod stays connected. Booting fails if not enough tokens are available. Booting on a fetch network is free and deducts no tokens.
- An empty or invalid `apiKey`, or too few tokens, makes `boot` hang instead of failing. See [Debugging BrowserPod](https://browserpod.io/docs/guides/common-errors.md#the-pod-never-finishes-booting).
- For how the Pod’s filesystem is structured and when its data persists, see [Filesystem](https://browserpod.io/docs/understanding-browserpod/filesystem.md).
