Skip to content

Commit 145e95b

Browse files
authored
fix(rbac): update the rbac ui readme (#1079)
1 parent 564a789 commit 145e95b

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

plugins/rbac/README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ Follow the RBAC backend plugin [README](https://github.com/janus-idp/backstage-p
1414

1515
**NOTE**
1616

17-
To enable create role button on Administration -> RBAC roles list page, the role associacted with your user should have the following permission policies associated with it. Add the following in your permission policies configuration file:
17+
To enable create role button on Administration -> RBAC roles list page, the role associated with your user should have the following permission policies associated with it. Add the following in your permission policies configuration file:
1818

1919
```CSV
2020
p, role:default/team_a, catalog-entity, read, allow
2121
p, role:default/team_a, policy-entity, create, allow
22-
g, user:default/user, role:default/team_a
22+
g, user:default/<login-id/user-name>, role:default/team_a
2323
```
2424

2525
---
2626

2727
#### Procedure
2828

29-
1. Install the RBAC UI plugin using the following command:
29+
1. Install the RBAC UI plugin executing the following command from the Backstage root directory :
3030

3131
```console
3232
yarn workspace app add @janus-idp/backstage-plugin-rbac
@@ -50,9 +50,31 @@ g, user:default/user, role:default/team_a
5050
export const Root = ({ children }: PropsWithChildren<{}>) => (
5151
<SidebarPage>
5252
<Sidebar>
53-
...
54-
<Administration />
55-
...
53+
...
54+
<Administration />
55+
...
56+
<Sidebar>
5657
</SidebarPage>
5758
);
5859
```
60+
61+
4. For users with vanilla backstage instance, would need to integrate [`Auth`](https://backstage.io/docs/auth/) in to the instance:
62+
63+
- ```yaml title="app-config.yaml"
64+
# see https://backstage.io/docs/auth/ to learn about auth providers
65+
environment: development
66+
providers:
67+
# Plugin: GitHub
68+
github:
69+
development:
70+
clientId: ${GITHUB_BUCKET_CLIENT_ID}
71+
clientSecret: ${GITHUB_BUCKET_SECRET}
72+
# Plugin: BitBucket
73+
bitbucket:
74+
development:
75+
clientId: ${BIT_BUCKET_CLIENT_ID}
76+
clientSecret: ${BIT_BUCKET_SECRET}
77+
...
78+
```
79+
80+
- Integrate the [`SignIn`](https://backstage.io/docs/auth/#sign-in-configuration) component to be able to sign-in to the Backstage instance.

0 commit comments

Comments
 (0)