Skip to content

Commit 2f597b8

Browse files
authored
Updated doco
Updated the README to explain in more detail how to create an API key and save it
1 parent 8ca41c0 commit 2f597b8

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ When you add this to GitHub Actions we will analyze your web app everytime you d
55
public endpoint and let you know if what you've just deployed is secure and meets your
66
requirements.
77

8+
See the section below
9+
810
```
911
name: Example Workflow Using SecureStack Web Vulnerability Exposure Action
1012
on: push
@@ -17,7 +19,7 @@ jobs:
1719
uses: SecureStackCo/[email protected]
1820
with:
1921
securestack_api_key: ${{ secrets.SECURESTACK_API_KEY_SECRET }}
20-
securestack_app_id: <Application Id>
22+
securestack_app_id: <put your application id here>
2123
severity: critical
2224
flags: '--dom -r'
2325
```
@@ -26,13 +28,14 @@ NOTE - to understand possible values for the action input `flags`, run the Secur
2628

2729
`$ bloodhound-cli recon --help`
2830

29-
## Getting your SecureStack API Key
31+
## Create your SecureStack API Key and save as GitHub Secret
3032

3133
1. Log in to [SecureStack](https://app.securestack.com) and go to the Profile -> GENERATE KEY screen.
3234
2. Generate an API key and copy the value.
33-
3. Paste into the value of a secret called SECURESTACK_API_KEY_SECRET in the GitHub repo settings.
35+
3. Go to Settings for your GitHub repository and click on Secrets at the bottom left.
36+
4. Create a new secret named SECURESTACK_API_KEY_SECRET and paste the value from step 2 into the field.
3437

35-
## Getting your SecureStack Application ID
38+
## Retreiving your SecureStack Application ID
3639

3740
1. Log in to [SecureStack](https://app.securestack.com).
3841
2. Open the application you wish to analyse.

0 commit comments

Comments
 (0)