You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workspaces/sandbox/README.md
+6-34Lines changed: 6 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,42 +4,12 @@ This plugin provides the new developer sandbox experience for the Red Hat Develo
4
4
5
5
## Configuration
6
6
7
-
This plugin needs the following to be configured in the `app-config.yaml` file:
7
+
This plugin needs the following to be configured in the `app-config.local.yaml` file:
8
8
9
9
1. The URL of the registration-service-api production server.
10
10
2. The URL of the kube-api production server.
11
11
3. The site key for Google Recaptcha. The keys can be obtained from the Google Recaptcha admin console.
12
12
13
-
## Dynamic Plugin Configuration
14
-
15
-
This is the configuration that needs to be added to the `app-config.yaml` file to enable the sandbox dynamic plugin:
16
-
17
-
```yaml
18
-
dynamicPlugins:
19
-
frontend:
20
-
red-hat-developer-hub.backstage-plugin-sandbox:
21
-
appIcons:
22
-
- name: homeIcon
23
-
importName: SandboxHomeIcon
24
-
- name: activitiesIcon
25
-
importName: SandboxActivitiesIcon
26
-
dynamicRoutes:
27
-
- path: /
28
-
importName: SandboxPage
29
-
menuItem:
30
-
icon: homeIcon
31
-
text: Home
32
-
- path: /activities
33
-
importName: SandboxActivitiesPage
34
-
menuItem:
35
-
icon: activitiesIcon
36
-
text: Activities
37
-
```
38
-
39
-
## Development
40
-
41
-
To start the app, run:
42
-
43
13
```sh
44
14
yarn install
45
15
yarn dev
@@ -51,14 +21,16 @@ To generate knip reports for this app, run:
51
21
yarn backstage-repo-tools knip-reports
52
22
```
53
23
54
-
## Local Frontend Setup (provisional)
24
+
## Development
55
25
56
-
The Sandbox plugin uses Red Hat SSO to authenticate users accessing the Sandbox backend. This section explains how to configure your local RHDH Sandbox UI to connect with Red Hat SSO and the Sandbox backend.
26
+
To start the app locally, run:
57
27
58
-
0.`export QUAY_NAMESPACE=<your-quay-namespace>`
59
28
1.`cd workspaces/sandbox`
60
29
2.`yarn install`
61
30
3.`make start-rhdh-local`
62
31
63
32
Please, note that every time you want to re deploy, you need to run:
64
33
`make stop-rhdh-local`
34
+
35
+
NOTE: the app uses prod RH SSO as auth provider and sandbox stage backend by default
36
+
( those can be configured in `app-config.local.yaml` )
0 commit comments