Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.amplication.com/llms.txt

Use this file to discover all available pages before exploring further.

Amplication offers seamless integration with Backstage, an open platform for building developer portals. This integration allows you to combine Backstage’s catalog capabilities with Amplication’s resource scaffolding features.

​
Available Plugins

Amplication provides two complementary Backstage plugins:
Catalog Backend Module Plugin: Fetches template data from your Amplication account into your Backstage Catalog, presenting them as ServiceTemplate components.
Scaffolder Backend Module Plugin: Provides the amplication:scaffold-service action for creating new services through Amplication’s API.

​
Installation Process

Before starting, you’ll need an Amplication API token. Here’s how to set up the integration:
1

Update app-config.yaml

Configure your app-config.yaml with Amplication settings:
app-config.yaml
catalog:
  locations:
    - type: amplication
      target: https://server.amplication.com/graphql

amplication:
  appUrl: https://app.amplication.com
  apiUrl: https://server.amplication.com/graphql
  token: ${AMPLICATION_TOKEN}
2

Add plugins

Install the required plugins using yarn:
yarn workspace backend add @backstage-community/plugin-catalog-backend-module-amplication
yarn workspace backend add @backstage-community/plugin-scaffolder-backend-module-amplication
3

Install the plugins

Update your backend configuration file, packages/backend/src/index.ts:
packages/backend/src/index.ts
const backend = createBackend();

// Add the following line
backend.add(
  import('@backstage-community/plugin-scaffolder-backend-module-amplication'),
);
backend.add(
  import('@backstage-community/plugin-catalog-backend-module-amplication'),
);

backend.start();
4

Add the action template file

Add the template file to your Backstage catalog

​
Using the Integration

Once installed, you can:
  • Find templates in the Home tab by filtering for Type=ServiceTemplate or using Tags=amplication / Tags=servicetemplate
  • Access the “Scaffold a New Service” option in the Create page to build new services using your templates