README


What is Backstage?
Backstage is an open platform for building developer portals. Powered by a centralized software catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly — without compromising autonomy.
Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

Out of the box, Backstage includes:
- Backstage Software Catalog for managing all your software (microservices, libraries, data pipelines, websites, ML models, etc.)
- Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices
- Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
- Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality
Backstage was created by Spotify but is now hosted by the Cloud Native Computing Foundation (CNCF) as a Sandbox level project. Read the announcement here.
Project roadmap
A detailed project roadmap, including already delivered milestones, is available here.
Getting Started
Check out the documentation on how to start using Backstage.
Documentation
Community
License
Copyright 2020-2021 © The Backstage Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage
Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
Security
Please report sensitive security issues via Spotify's bug-bounty program rather than GitHub.
For further details please see our complete security release process.
Extension points exported contracts — how you extend this code
ScmIntegrationRegistry (Interface)
(no doc) [7 implementers]
packages/integration/src/registry.ts
ScmAuthApi (Interface)
(no doc) [14 implementers]
packages/integration-react/src/api/ScmAuthApi.ts
Step (Interface)
(no doc) [11 implementers]
packages/cli/src/commands/install/types.ts
PublisherBase (Interface)
(no doc) [10 implementers]
packages/techdocs-common/src/stages/publish/types.ts
DocumentCollator (Interface)
(no doc) [9 implementers]
packages/search-common/src/types.ts
EntityProvider (Interface)
(no doc) [10 implementers]
plugins/catalog-backend/src/providers/types.ts
WorkflowRunner (Interface)
(no doc) [8 implementers]
plugins/scaffolder-backend/src/scaffolder/tasks/types.ts
SearchApi (Interface)
(no doc) [6 implementers]
plugins/search/src/apis.ts
Core symbols most depended-on inside this repo
renderInTestApp
called by 504
packages/test-utils/src/testUtils/appWrappers.tsx
resolve
called by 480
packages/core-plugin-api/src/routing/useRouteRef.tsx
push
called by 419
packages/backend-common/src/scm/git.ts
render
called by 413
plugins/catalog-import/src/components/ImportStepper/ImportStepper.tsx
useApi
called by 312
packages/core-plugin-api/src/apis/system/useApi.tsx
useStyles
called by 312
packages/core-components/src/layout/Sidebar/SidebarSubmenu.tsx
get
called by 274
packages/backend-common/src/cache/CacheClient.ts
filter
called by 274
plugins/todo-backend/src/lib/TodoReader/TodoScmReader.ts
Shape
Function
3,515
Method
2,265
Class
909
Interface
558
Enum
45
Modules by API surface
plugins/ilert/src/api/client.ts36 symbols
plugins/catalog-react/src/filters.ts35 symbols
packages/techdocs-common/__mocks__/@azure/storage-blob.ts32 symbols
plugins/ilert/src/api/types.ts31 symbols
packages/config/src/reader.ts29 symbols
scripts/api-extractor.ts28 symbols
plugins/auth-backend/src/lib/passport/PassportStrategyHelper.test.ts27 symbols
plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts25 symbols
plugins/ilert/src/types.ts25 symbols
plugins/gitops-profiles/src/api.ts25 symbols
packages/backend-common/src/config.ts25 symbols
plugins/lighthouse/src/api.ts22 symbols
Dependencies from manifests, versioned
@acuris/aws-es-connection2.2.0 · 1×
@asyncapi/react-component1.0.0-next.32 · 1×
@azure/identity2.0.1 · 1×
@azure/msal-node1.1.0 · 1×
@azure/storage-blob12.5.0 · 1×
@backstage/app-defaults0.1.5 · 1×
@backstage/backend-common0.10.4 · 1×
@backstage/backend-tasks0.1.4 · 1×
@backstage/backend-test-utils0.1.14 · 1×
@backstage/catalog-client0.5.5 · 1×
@backstage/catalog-model0.9.10 · 1×
@backstage/cli0.12.0 · 1×
Datastores touched
(mysql)Database · 1 repos
foodbDatabase · 1 repos
dbnameDatabase · 1 repos
foodbDatabase · 1 repos
userdbnameDatabase · 1 repos
dbnameDatabase · 1 repos
shuffle_ransack_playbackDatabase · 1 repos
unwitting_fox_jumpsDatabase · 1 repos