|
| 1 | +--- |
| 2 | +title: "Deploy Backstage Developer Portal through the Linode Marketplace" |
| 3 | +description: "Deploy a Backstage framework for developing developer portals" |
| 4 | +published: 2020-01-31 |
| 5 | +modified: 2025-01-31 |
| 6 | +keywords: ['backstage', 'developer portal'] |
| 7 | +tags: ["ubuntu", "marketplace", "developer portal", "developer", "linode platform", "cloud manager"] |
| 8 | +external_resources: |
| 9 | +- '[Backstage](https://backstage.io/)' |
| 10 | +- '[Backstage documentation](https://backstage.io/docs/overview/what-is-backstage)' |
| 11 | +aliases: ['/products/tools/marketplace/guides/backstage/'] |
| 12 | +authors: ["Akamai"] |
| 13 | +contributors: ["Akamai"] |
| 14 | +license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' |
| 15 | +--- |
| 16 | + |
| 17 | +Backstage is an open-source platform for building developer portals designed to simplify and unify software development processes. It provides a centralized hub for managing services, tools, and documentation. Backstage enables teams to improve efficiency, collaboration, and scalability across projects. |
| 18 | + |
| 19 | +## Prerequisites |
| 20 | + |
| 21 | +The Backstage application for Cloud Manager is configured with a Github authentication and allows you to integrate pulling catalog entities from Github directly. Before you can deploy the One-Click application, you need to create an OAuth application and authorize it to use your domain name. |
| 22 | + |
| 23 | +To learn how to configure authentication to Github, see [Setting up authentication](https://backstage.io/docs/getting-started/config/authentication/#setting-up-authentication). |
| 24 | + |
| 25 | +For reference, you can use the following image as a guideline to configure the OAuth application. |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +{{< note >}} |
| 30 | +Optionally, you can configure the [Github integration](https://backstage.io/docs/getting-started/config/authentication/#setting-up-a-github-integration), but it's not required for the deployment of the Backstage One-Click app. |
| 31 | +{{< /note >}} |
| 32 | + |
| 33 | +You only need to perform instructions from the linked sections. No need to perform following steps from linked pages. |
| 34 | +Once done, save the following data to use in the following steps: |
| 35 | + |
| 36 | +- Client ID, |
| 37 | +- Client Secret, |
| 38 | +- Personal Access Token (not required). |
| 39 | + |
| 40 | +## Deploying a Marketplace App |
| 41 | + |
| 42 | +{{% content "deploy-marketplace-apps-shortguide" %}} |
| 43 | + |
| 44 | +{{% content "marketplace-verify-standard-shortguide" %}} |
| 45 | + |
| 46 | +{{< note >}} |
| 47 | +**Estimated deployment time:** Once a compute instance finishes provisioning, the Backstage installation takes 3-5 minutes. |
| 48 | +{{< /note >}} |
| 49 | + |
| 50 | +## Configuration Options |
| 51 | + |
| 52 | +- **Supported distributions:** Ubuntu 24.04 LTS |
| 53 | +- **Recommended minimum plan:** All plan types and sizes can be used. |
| 54 | + |
| 55 | +### Backstage Options |
| 56 | + |
| 57 | +- **Your Linode API token** *(required)*: Linode API token to create DNS records for Backstage. |
| 58 | +- **The subdomain for the DNS record** *(required)*: Subdomain to be created for Backstage. Enter the same value you provided when creating the OAuth application in the previous section. |
| 59 | +- **The domain for the DNS record** *(required)*: The domain name for your Backstage instance. Enter the same value you provided when creating the OAuth application in the previous section. |
| 60 | +- **Email address** *(required)*: Email address to use for generating the SSL certificates and configuring the server and DNS records. |
| 61 | +- **Allowed IPs**: IP addresses allowed to access the frontend. If no IP addresses are provided, the frontend will be accessible to the public. It's highly recommended to enter your IP address. |
| 62 | +- **Backstage application name** *(required)*: The name for the Backstage application. The application will live under this name in backstage home directory. |
| 63 | +- **Github Oauth Client ID** *(required)*: OAuth Client ID created in Github, from the previous section. |
| 64 | +- **Github Oauth Client Secret** *(required)*: OAuth Client Secret created in Github, from the previous section. |
| 65 | +- **Github Username** *(required)*: Your Github username for you to authorize the Github backend authentication. |
| 66 | +- **Backstage Organization Name** *(required)*: The organization name that will be used in the backstage configuration. |
| 67 | +- **Github Personal Access Token**: The personal access token to integrate Backstage with Github. This will you to load catalog entities from Github. |
| 68 | + |
| 69 | +{{% content "marketplace-required-limited-user-fields-shortguide" %}} |
| 70 | + |
| 71 | +{{% content "marketplace-custom-domain-fields-shortguide" %}} |
| 72 | + |
| 73 | +{{% content "marketplace-special-character-limitations-shortguide" %}} |
| 74 | + |
| 75 | +## Getting Started After Deployment |
| 76 | + |
| 77 | +To get started with Backstage: |
| 78 | + |
| 79 | +1. Open a web browser and navigate to your Backstage instance by using the domain name provided during the setup. |
| 80 | +1. Log into your Github account for the authentication. |
| 81 | + |
| 82 | +  |
| 83 | + |
| 84 | +1. Go to the **Settings** tab, to see your authentication. |
| 85 | + |
| 86 | +  |
| 87 | + |
| 88 | +You are now ready to start working with Backstage. |
| 89 | + |
| 90 | +{{% content "marketplace-update-note-shortguide" %}} |
0 commit comments