Skip to content

Commit 5b5568f

Browse files
authored
docs(servicenow): add missing ServiceNow config in README (#926)
Signed-off-by: Paul Schultz <[email protected]>
1 parent cecba73 commit 5b5568f

File tree

1 file changed

+40
-28
lines changed

1 file changed

+40
-28
lines changed

plugins/servicenow-actions/README.md

Lines changed: 40 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,46 @@ yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-servic
2020

2121
## Configuration
2222

23-
[Register](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) the ServiceNow actions by modifying the `packages/backend/src/plugins/scaffolder.ts` file from your project with the following changes:
24-
25-
```ts title="packages/backend/src/plugins/scaffolder.ts"
26-
/* highlight-add-next-line */
27-
import { createServiceNowActions } from '@janus-idp/backstage-scaffolder-backend-module-servicenow';
28-
29-
export default async function createPlugin(
30-
env: PluginEnvironment,
31-
): Promise<Router> {
32-
// ...
33-
34-
/* highlight-add-next-line */
35-
const actions = [
36-
...builtInActions,
37-
...createServiceNowActions({ config: env.config }),
38-
];
39-
40-
return await createRouter({
41-
actions,
42-
logger: env.logger,
43-
config: env.config,
44-
database: env.database,
45-
reader: env.reader,
46-
catalogClient,
47-
identity: env.identity,
48-
});
49-
}
50-
```
23+
1. [Register](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) the ServiceNow actions by modifying the `packages/backend/src/plugins/scaffolder.ts` file from your project with the following changes:
24+
25+
```ts title="packages/backend/src/plugins/scaffolder.ts"
26+
/* highlight-add-next-line */
27+
import { createServiceNowActions } from '@janus-idp/backstage-scaffolder-backend-module-servicenow';
28+
29+
export default async function createPlugin(
30+
env: PluginEnvironment,
31+
): Promise<Router> {
32+
// ...
33+
34+
/* highlight-add-next-line */
35+
const actions = [
36+
...builtInActions,
37+
...createServiceNowActions({ config: env.config }),
38+
];
39+
40+
return await createRouter({
41+
actions,
42+
logger: env.logger,
43+
config: env.config,
44+
database: env.database,
45+
reader: env.reader,
46+
catalogClient,
47+
identity: env.identity,
48+
});
49+
}
50+
```
51+
52+
2. Update the `app-config.yaml` file to include the following config:
53+
54+
```yaml title="app-config.yaml"
55+
servicenow:
56+
# The base url of the ServiceNow instance.
57+
baseUrl: ${SERVICENOW_BASE_URL}
58+
# The username to use for authentication.
59+
username: ${SERVICENOW_USERNAME}
60+
# The password to use for authentication.
61+
password: ${SERVICENOW_PASSWORD}
62+
```
5163
5264
## Usage
5365

0 commit comments

Comments
 (0)