@backstage/plugin-scaffolder-backend-module-workspace-database

This module provides a database-backed workspace provider for the scaffolder backend.

Warning: This module is intended for development use only. In production, use an external storage provider like GCS (@backstage/plugin-scaffolder-backend-module-gcp).

Installation

yarn add @backstage/plugin-scaffolder-backend-module-workspace-database
Copy

Add to your backend:

// packages/backend/src/index.ts
backend.add(
  import('@backstage/plugin-scaffolder-backend-module-workspace-database'),
);
Copy

Configure in your app-config:

scaffolder:
  taskRecovery:
    enabled: true
    workspaceProvider: database
Copy

The module does not register the provider in production by default. Although it is not recommended, you can explicitly enable it with the following configuration:

scaffolder:
  taskRecovery:
    database:
      dangerouslyEnableInProduction: true
Copy

Limitations

• 50 MB maximum workspace size.
• Disabled in production unless you set dangerouslyEnableInProduction to true.
• Not recommended for high-volume or large workspace scenarios.