Skip to content

Commit 39e3059

Browse files
committed
updated README and added new pictures of API key and app_id creation
1 parent 1f7096f commit 39e3059

7 files changed

+6
-2654
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,16 @@ NOTE - to understand possible values for the action input `flags`, run the Secur
2828
## Create your SecureStack API Key and save as GitHub Secret
2929

3030
1. Log in to [SecureStack](https://app.securestack.com) with your GitHub credentials.
31-
2. Go to Settings in the lower left corner, and then select the 6th tab: API.
32-
3. Generate a new API key and copy the value.
33-
4. Now back in GitHub, go to Settings for your GitHub repository and click on Secrets at the bottom left.
34-
5. Create a new secret named SECURESTACK_API_KEY and paste the value from step 2 into the field.
31+
2. Go to Settings in the lower left corner, and then select the 6th tab: API.![Create API key](./images/securestack-create-apikey.png)
32+
3. Generate a new API key and copy the value.![Copy API key](./images/securestack-copy-apikey.png)
33+
4. Now back in GitHub, go to Settings for your GitHub repository and click on Secrets, and then Actions at the bottom left.
34+
5. Create a new secret named SECURESTACK_API_KEY and paste the value from step 2 into the field and click "Add secret".![Create GitHub Secret for API key](./images/securestack-github-apikey-secret.png)
3535

3636
## Retreiving your SecureStack Application ID
3737

3838
1. Log in to [SecureStack](https://app.securestack.com).
39-
2. Open the application you wish to analyse.
40-
3. In the browser URL bar you will see something like this: ```https://app.securestack.com/settings/applications/269aa3a5-9be8-1a23-1234-123456abcdef```
41-
4. Copy the last part of that as the Application ID. (ex: 269aa3a5-9be8-1a23-1234-123456abcdef)
42-
5. Now go back to the GitHub UI and paste into the value of the `securestack_app_id` action input for the step using the SecureStack action in your workflow.
39+
2. In the application drop down at the top left choose the application you want to use and click on "Copy Application ID" ![Copy Application ID](./images/securestack-copy-appid.png)
40+
3. Create a new secret named SECURESTACK_APP_ID and paste the value from step 2 into the field and click "Add secret".![Create GitHub Secret for app_id](./images/securestack-github-appid-secret.png)
4341

4442
## What types of components will this BoM include?
4543
1. All your software components including third-party libraries and frameworks

images/securestack-copy-apikey.png

66.9 KB
Loading

images/securestack-copy-appid.png

118 KB
Loading

images/securestack-create-apikey.png

117 KB
Loading
154 KB
Loading
152 KB
Loading

0 commit comments

Comments
 (0)