Backstage Software Catalog and Developer Platform
GitHub
Docs
Plugins
Blog
Demos
Newsletter
›
Publishing
Overview
What is Backstage?
Architecture overview
Roadmap
Vision
The Spotify Story
Strategies for adopting
Stability Index
Support and community
Backstage Glossary
Logo assets
Getting Started
Getting Started
Create an App
Running Backstage Locally
App configuration
Configuring App with plugins
Customize the look-and-feel of your App
Keeping Backstage Updated
Key Concepts
Contributors
Backstage Project Structure
Local Development
CLI
CLI Overview
CLI Commands
Linking in Local Packages
Core Features
Software Catalog
Overview
The Life of an Entity
Catalog Configuration
System Model
YAML File Format
Entity References
Well-known Annotations
Well-known Relations
Well-known Statuses
Extending the model
External integrations
Catalog Customization
API
Kubernetes
Overview
Installation
Configuration
Troubleshooting
Software Templates
Overview
Configuration
Adding your own Templates
Writing Templates
Builtin actions
Writing Custom Actions
Writing Custom Field Extensions
Migrating to v1beta3 templates
Backstage Search
Overview
Getting Started with Search
Search Concepts
Search Architecture
Search Engines
"HOW TO" guides
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
Integrations
Overview
AWS S3
Locations
Discovery
Azure
Locations
Org Data
Bitbucket
Locations
Discovery
Datadog
Installation
GitHub
Locations
Discovery
Org Data
GitLab
Locations
Google GCS
Locations
LDAP
Org Data
Plugins
Intro to plugins
Existing plugins
Create a Backstage Plugin
Plugin Development
Structure of a Plugin
Integrate into the Software Catalog
Composability System
Plugin Analytics
Backends and APIs
Proxying
Backend plugins
Call Existing API
GitHub Apps for Backend Authentication
URL Reader
Testing
Testing with Jest
Publishing
Publishing
Publish private
Add to Marketplace
Observability
Configuration
Static Configuration in Backstage
Reading Backstage Configuration
Writing Backstage Configuration Files
Defining Configuration for your Plugin
Auth and identity
Adding Authentication
Included providers
Auth0
Bitbucket
Azure
GitHub
GitLab
Google
Okta
OneLogin
Adding authentication providers
Using authentication and identity
Identity resolver
Auth backend
OAuth and OpenID Connect
Auth backend classes
Glossary
Deployment
Overview
Docker
Kubernetes
Helm
Heroku
Designing for Backstage
Design
Contributing to Storybook
Figma
API Reference
Guides
Utility APIs
API Reference
Package Index
Tutorials
Future developer journey
Adding Custom Plugin to Existing Monorepo App
Migrating away from @backstage/core
Configuring Plugin Databases
Switching Backstage from SQLite to PostgreSQL
Using the Backstage Proxy from Within a Plugin
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
ADR011: Plugin Package Structure
FAQ
FAQ
Edit
Publish private
TODO
Last updated on 10/16/2021
←
Publishing
Add to Marketplace
→
TODO