Documentation

Understand, try, and administer Backstage

Understand Backstage	Try Backstage	Administration	Additional Features
Learn about Backstage. What is Backstage? Technical Overview Architecture overview Introduction to Plugins Software Catalog Overview System Model Authentication in Backstage Backend System Overview New Frontend System Overview Security & Threat Model Release & Versioning Policy	Build a customizable Backstage app. Create your Backstage App Logging into Backstage Using the Catalog Viewing the Catalog Viewing what you own Viewing entity relationships Filtering the Catalog Managing Components Register Create Update Unregister/delete Configuring a Software Template Creating a Software Template Check health of services with Kubernetes Backstage CLI	Configure, Deploy, & Upgrade. Setup Authentication Configure a Database Add plugins to expand functionality Install Notification System Setup permissions Customize the look-and-feel Customize Backstage homepage Integrate with external providers to read or publish data Deploy Backstage to Production	Additional Backstage Features Search Software Catalog Software Templates (aka Scaffolder) TechDocs - a docs-like-code solution

Plugin Development	References	Contribute to Backstage
Creating and Configuring Plugins Introduction to Plugins Create a Backstage Plugin Plugin Development Integrating a Plugin into the Software Catalog Integrating Search into a Plugin Defining Configuration for your Plugin Tutorial: using Permissions in your Plugin Plugin Analytics	Glossary, FAQ, and other reference material. Glossary Designing for Backstage Architecture Decision Records (ADRs) Deprecations Utility APIs API References FAQ	Contributions are welcome and greatly appreciated! Contributor's Guide Getting Involved Backstage Project Structure