Backstage Service Catalog and Developer Platform
GitHub
Docs
Plugins
Blog
Demos
Newsletter
›
Backends and APIs
Overview
What is Backstage?
Architecture overview
Project roadmap
Vision
The Spotify Story
Strategies for adopting
Stability Index
Logo assets
Getting Started
Getting Started
Running Backstage Locally
Development Environment
Create an App
App configuration
Configuring App with plugins
Customize the look-and-feel of your App
Deployment
Kubernetes
Kubernetes and Helm
Other
CLI
Overview
Commands
Core Features
Kubernetes
Overview
Installation
Configuration
Software Catalog
Overview
Installing in your Backstage App
Catalog Configuration
System Model
YAML File Format
Entity References
Well-known Annotations
Well-known Relations
Extending the model
External integrations
API
Software Templates
Overview
Installing in your Backstage App
Adding your own Templates
Extending the Scaffolder
Creating your own Templater
Create your own Publisher
Create your own Preparer
Backstage Search
Overview
Search Architecture
TechDocs
Overview
Getting Started
Concepts
TechDocs Architecture
Creating and Publishing Documentation
TechDocs Configuration Options
Using Cloud Storage for TechDocs generated files
Configuring CI/CD to generate and publish TechDocs sites
"HOW TO" guides
Troubleshooting
FAQ
Plugins
Intro to plugins
Existing plugins
Create a Backstage Plugin
Plugin Development
Structure of a Plugin
Integrate into the Service Catalog
Composability System Migration
Backends and APIs
Proxying
Backend plugin
Call Existing API
Testing
Testing with Jest
Publishing
Publishing
Publish private
Add to Marketplace
Configuration
Static Configuration in Backstage
Reading Backstage Configuration
Writing Backstage Configuration Files
Defining Configuration for your Plugin
Auth and identity
User Authentication and Authorization in Backstage
Adding authentication providers
Auth backend
OAuth and OpenID Connect
Glossary
Auth backend classes
Designing for Backstage
Design
Contributing to Storybook
Figma
API references
TypeScript API
Utility APIs
reference/utility-apis/README
createPlugin
createPlugin - feature flags
createPlugin - router
Backend APIs
Backend
Tutorials
Future developer journey
Monorepo App Setup With Authentication
Adding Custom Plugin to Existing Monorepo App
Architecture Decision Records (ADRs)
Overview
ADR001: Architecture Decision Record (ADR) log
ADR002: Default Software Catalog File Format
ADR003: Avoid Default Exports and Prefer Named Exports
ADR004: Module Export Structure
ADR005: Catalog Core Entities
ADR006: Avoid React.FC and React.SFC
ADR007: Use MSW to mock http requests
ADR008: Default Catalog File Name
ADR009: Entity References
ADR010: Use the Luxon Date Library
Support
Support and community
Backstage Project Structure
Glossary
Backstage Glossary
FAQ
FAQ
Edit
Backend plugin
TODO
←
Proxying
Call Existing API
→
TODO