diff --git a/docs/auth/index--new.md b/docs/auth/index--new.md index 0a2e980658..b1948f3a7e 100644 --- a/docs/auth/index--new.md +++ b/docs/auth/index--new.md @@ -1,11 +1,11 @@ --- -id: index +id: index--new title: Authentication in Backstage description: Introduction to authentication in Backstage --- :::info -This documentation is written for [the new frontend system](../../frontend-system/index.md). If you are on the old frontend system you may want to read [its own article](./index.md) instead. +This documentation is written for [the new frontend system](../frontend-system/index.md). If you are on the old frontend system you may want to read [its own article](./index.md) instead. ::: The authentication system in Backstage serves two distinct purposes: sign-in and identification of users, as well as delegating access to third-party resources. It is possible to configure Backstage to have any number of authentication providers, but only one of these will typically be used for sign-in, with the rest being used to provide access to external resources. @@ -358,7 +358,7 @@ The method with which frontend plugins request access to third-party services is There are generic authentication providers for OAuth2 and SAML. These can reduce the amount of code needed to implement a custom authentication provider that adheres to these standards. -Backstage uses [Passport](http://www.passportjs.org/) under the hood, which has a wide library of authentication strategies for different providers. See[Add authentication provider](add-auth-provider.md) for details on adding a new Passport-supported authentication method. +Backstage uses [Passport](http://www.passportjs.org/) under the hood, which has a wide library of authentication strategies for different providers. See [Add authentication provider](add-auth-provider.md) for details on adding a new Passport-supported authentication method. ## Custom ScmAuthApi Implementation diff --git a/docs/auth/index.md b/docs/auth/index.md index 892f7a408f..6b6b57d503 100644 --- a/docs/auth/index.md +++ b/docs/auth/index.md @@ -5,7 +5,7 @@ description: Introduction to authentication in Backstage --- :::info -This documentation is written for the old frontend system. If you are on the [new frontend system](../../frontend-system/index.md) you may want to read [its own article](./index--new.md) instead. +This documentation is written for the old frontend system. If you are on the [new frontend system](../frontend-system/index.md) you may want to read [its own article](./index--new.md) instead. ::: The authentication system in Backstage serves two distinct purposes: sign-in and diff --git a/docs/getting-started/config/authentication--new.md b/docs/getting-started/config/authentication--new.md index 04b1e2b46b..ee71bf7913 100644 --- a/docs/getting-started/config/authentication--new.md +++ b/docs/getting-started/config/authentication--new.md @@ -1,5 +1,5 @@ --- -id: authentication +id: authentication--new title: Authentication description: How to setup authentication for your Backstage app --- @@ -14,7 +14,7 @@ Audience: Admins or Developers We'll be walking you through how to setup authentication for your Backstage app using GitHub. After finishing this guide, you'll have both working authentication and users in your Backstage app to match to the users logging in! -There are multiple authentication providers available for you to use with Backstage, feel free to follow [their instructions for adding authentication](../../auth/index.md). +There are multiple authentication providers available for you to use with Backstage, feel free to follow [their instructions for adding authentication](../../auth/index--new.md). :::note Note @@ -90,7 +90,7 @@ const signInPage = SignInPageBlueprint.make({ }); ``` -Search for `const app = createApp({` in this file, and replace: +Search for the `createApp()` function call in this file, and replace: ```tsx title="packages/app/src/App.tsx" export default createApp({ @@ -137,7 +137,7 @@ auth: /* highlight-add-end */ ``` -What this will do is take the user details provided by the auth provider and match that against a User in the Catalog. In this case - `usernameMatchingUserEntityName` - will match the GitHub user name with the `metadata.name` value of a User in the Catalog, if none is found you will get an "Failed to sign-in, unable to resolve user identity" message. We'll cover this in the next few sections. +What this will do is take the user details provided by the auth provider and match that against a User in the Catalog. In this case - `usernameMatchingUserEntityName` - will match the GitHub user name with the `metadata.name` value of a User in the Catalog, if none is found you will get a "Failed to sign-in, unable to resolve user identity" message. We'll cover this in the next few sections. Learn more about this topic in the [Sign-in Resolvers](../../auth/identity-resolver.md#sign-in-resolvers) documentation. @@ -170,7 +170,7 @@ Sometimes the frontend starts before the backend resulting in errors on the sign The recommended approach for adding Users, and Groups, into your Catalog is to use one of the existing Org Entity Providers - [like this one for GitHub](https://backstage.io/docs/integrations/github/org) - or if those don't work you may need to [create one](https://backstage.io/docs/features/software-catalog/external-integrations#custom-entity-providers) that fits your Organization's needs. -For the sake of this guide we'll simply step you though adding a User to the `org.yaml` file that is included when you create a new Backstage instance. Let's do that: +For the sake of this guide we'll simply step you through adding a User to the `org.yaml` file that is included when you create a new Backstage instance. Let's do that: 1. First open the `/examples/org.yaml` file in your text editor of choice 2. At the bottom we'll add the following YAML: @@ -192,7 +192,7 @@ Let's restart Backstage from the terminal once more, by stopping it with `Ctrl+C To learn more about Authentication in Backstage, here are some docs you could read: -- [Authentication in Backstage](../../auth/index.md) +- [Authentication in Backstage](../../auth/index--new.md) - [Using organizational data from GitHub](../../integrations/github/org.md) ## Setting up a GitHub Integration