For most Backstage installations, installing the standalone app will bring you the best and most streamlined experience. In this guide you will:
- Deploy Backstage Standalone with npm packages
- Run Backstage Standalone with a SQLite in-memory database and demo content
This guide assumes a basic understanding of working on a Linux based operating system using tools like apt-get, npm, yarn, curl. Docker knowledge is also helpful for making the best use of your Backstage installation.
If you are planning to contribute plugins or the project in general, we advise you to use the Getting Started for Contributors guide to do a repository-based installation.
- Access to a Linux-based operating system, such as Linux, MacOS or Windows Subsystem for Linux
- An account with elevated rights to install the dependencies
- Node.js Active LTS Release installed (currently v14) using one of these methods:
- If the system is not directly accessible over your network the following ports need to be opened: 3000, 7007. This is quite uncommon, unless when you're installing in a container, VM or remote system.
Create your Backstage App
To install the Backstage Standalone app, we make use of
npx, a tool to run
Node executables straight from the registry. This tool is part of your Node.js
installation. Running the command below will install Backstage. The wizard will
create a subdirectory inside your current working directory.
The wizard will ask you
- The name of the app, which will also be the name of the directory
- The database type to use for the backend. For this guide, you'll be using the SQLite option.
Run the Backstage app
When the installation is complete you can go to the application directory and
start the app. The
yarn dev command will run both the frontend and backend as
separate processes (named
) in the same window.
cd my-backstage-app yarn dev
It might take a little while, but as soon as the message
 webpack compiled successfully appears, you can open a browser and directly
navigate to your freshly installed Backstage portal at
You can start exploring the demo immediately. Please note that the in-memory
database will be cleared when you restart the app, so you'll most likely want to
carry on with the database steps.
In the next part of this tutorial, you'll learn how to change to a persistent database, configure authentication, and add your first integration. Continue with getting started: Configuring Backstage.