Backstage Software Catalog and Developer Platform
GitHub
Docs
Plugins
Blog
Releases
Demos
Community
›
Publishing
Overview
What is Backstage?
Architecture overview
Roadmap
Vision
The Spotify Story
Strategies for adopting
Release & Versioning Policy
Backstage Threat Model
Support and community
Backstage Glossary
Logo assets
Getting Started
Getting Started
Getting Started, configuring Backstage
Create an App
Running Backstage Locally
App configuration
Configuring App with plugins
Customize the look-and-feel of your App
Backstage homepage - Setup and Customization
Keeping Backstage Updated
Key Concepts
Contributors
Backstage Project Structure
Local Development
CLI
Overview
Build System
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
Kubernetes Authentication
Troubleshooting
Software Templates
Overview
Configuration
Adding your own Templates
Writing Templates
Builtin actions
Writing Custom Actions
Writing Custom Field Extensions
Writing custom step layouts
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 Addons
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
TechDocs CLI
"HOW TO" guides
Troubleshooting
FAQ
Integrations
Overview
AWS S3
Locations
Discovery
Azure
Locations
Discovery
Org Data
Bitbucket
Discovery
Bitbucket Cloud
Locations
Discovery
Bitbucket Server
Locations
Discovery
Datadog
Installation
Gerrit
Locations
Discovery
GitHub
Locations
Discovery
Org Data
GitHub Apps
GitLab
Locations
Discovery
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
Integrating Search into a plugin
Composability System
Customization (Experimental)
Plugin Analytics
Backends and APIs
Proxying
Backend plugins
Call Existing API
URL Reader
Testing
Testing with Jest
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
Authentication in Backstage
Included providers
Auth0
Atlassian
Bitbucket
Azure
GitHub
GitLab
Google
Google IAP
Okta
OneLogin
OAuth 2 Custom Proxy
Sign-in Identities and Resolvers
OAuth and OpenID Connect
Contributing New Providers
Troubleshooting Auth
Glossary
Permissions
Overview
Concepts
Getting Started
Writing a permission policy
Frontend Integration
Defining custom permission rules
Tutorial: using Permissions in your plugin
1. Tutorial setup
2. Adding a basic permission check
3. Adding a resource permission check
4. Authorizing access to paginated data
5. Frontend Components with Authorization
Deployment
Overview
Scaling
Docker
Kubernetes
Heroku
Designing for Backstage
Design
Contributing to Storybook
Figma
API Reference
Guides
Utility APIs
API Reference
Package Index
Deprecations
Tutorials
Future developer journey
Adding Custom Plugin to Existing Monorepo App
React Router 6.0 Migration
Package Role Migration
Migrating away from @backstage/core
Configuring Plugin Databases
Switching Backstage from SQLite to PostgreSQL
Using the Backstage Proxy from Within a Plugin
Backend-to-Backend Authentication
Migration to Yarn 3
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'
'ADR012: Use Luxon.toLocaleString and date/time presets'
'ADR013: Proper use of HTTP fetching libraries'
FAQ
FAQ
Edit
Publish private
TODO
Last updated on 9/29/2022
←
Testing with Jest
Add to Marketplace
→
TODO