E2B Dashboard

The dashboard uses a single team API key for authentication. It does not use user accounts or external auth providers.

1. Via UI: Visiting / presents a form to enter the key. The key is validated against the infra-api and stored in an httpOnly e2b_api_key cookie. All upstream requests are made server-side using the X-API-Key header, ensuring the key is never exposed to client-side JavaScript.
2. Via Environment Variable: Setting E2B_API_KEY at server start enables single-user mode. In this mode, the login form and sign-out options are automatically hidden.

To run the E2B Dashboard locally, ensure you have a running E2B infrastructure deployment and a team API key (starting with e2b_).

1. Clone the repository:

   git clone https://github.com/e2b-dev/dashboard.git
   cd dashboard

2. Install dependencies using Bun:

   bun install

3. Configure environment variables: Copy the example file and set PUBLIC_E2B_DOMAIN to point to your infrastructure domain.

   cp .env.example .env
   # Edit .env to set PUBLIC_E2B_DOMAIN

4. Start the development server:

   bun run dev

5. Authenticate: Open http://localhost:3000 in your browser and enter your team API key.

The dashboard can be deployed as a self-contained Docker image. You must provide the PUBLIC_E2B_DOMAIN at runtime to point the dashboard to your E2B cluster.

Build and run locally:

docker build -t e2b-dashboard .
docker run --rm -p 3001:3001 \
  -e PUBLIC_E2B_DOMAIN=your-domain.com \
  e2b-dashboard

Use a published release:

docker run --rm -p 3001:3001 us-docker.pkg.dev/e2b-artifacts/dashboard/dashboard:vX.Y.Z

Note on Ports: The default port is 3001. This avoids conflicts with the E2B API, which typically uses port 3000 when sharing a host network.

You can enable workload identity for a sandbox by providing a non-empty, valid tokens map in the SandboxIam configuration. This is done via the tokens field, which is a map of user-chosen names to SandboxIamToken definitions.

const iamConfig: SandboxIam = {
  tokens: {
    'my-token-name': {
      audience: 'my-audience',
      tokenType: 'some-type'
    }
  }
};

The E2B Dashboard uses two primary methods to authenticate requests and identify the team API key:

1. Environment Variable (E2B_API_KEY): In single-user self-hosted deployments, setting this environment variable provides permanent authentication. When this is set, the dashboard skips the API key entry form and hides all 'change API key' UI elements.
2. HTTP-only Cookie (e2b_api_key): For standard deployments, the API key is provided via a key form on the root path (/) and stored in a secure, httpOnly cookie.

If E2B_API_KEY is present, it takes precedence over the cookie.

The security of cookies (the secure flag) is determined by the DASHBOARD_COOKIE_SECURE environment variable.

• If DASHBOARD_COOKIE_SECURE is set to 'true', cookies will always be marked as secure.
• If DASHBOARD_COOKIE_SECURE is undefined, the dashboard defaults to secure: true in production environments and secure: false in other environments (like local development).

This setting affects all cookies managed by the dashboard, including the e2b_api_key.

Templates can be built using several request formats. For version 3 builds (TemplateBuildRequestV3), use the name field which can include a tag (e.g., "my-template:v1").

Key build configuration options include:

• fromImage: Image to use as a base.
• fromTemplate: Template to use as a base.
• fromImageRegistry: Registry authentication (supports aws, gcp, or registry types).
• steps: A list of TemplateStep objects to execute.
• startCmd: Command to execute after build.
• readyCmd: Command to execute after build to check readiness.
• force: Whether to force the build regardless of cache.

// Example TemplateBuildStartV2
const buildRequest: TemplateBuildStartV2 = {
  fromImage: 'ubuntu:latest',
  steps: [
    { type: 'run', args: ['apt-get', 'update'], force: true }
  ],
  startCmd: 'python app.py',
  readyCmd: 'curl localhost:8080'
};

If you are upgrading, ensure you rename the following legacy variables to their current counterparts. The dashboard will report validation errors if deprecated variables are still set.