Skip to content

Commit

Permalink
Update README to include mayhem-url
Browse files Browse the repository at this point in the history
  • Loading branch information
Ross-ForAllSecure committed May 2, 2024
1 parent d3ddb97 commit d86ef18
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ The action accepts the follow inputs:
| | `html-report` | string | Path to the generated SARIF report |
| | `sarif-report` | string | Path to the generated HTML report |
| | `run-args` | string | Additional arguments to provide to the `mapi run` command. Argument values should be separated on new lines. <br><br>e.g.<br> <pre> run-args: \|<br> # Basic Auth<br> --basic-auth<br> login:password</pre><br>⚠️ Avoid wrapping values in quotes, as these will be escaped and included in the value passed to `mapi`.<br><br>⛔️ `"login:password"` <br>✅ `login:password` |
| | `mayhem-url` | string | Path to your Mayhem API instance, if you're using something other than the default of https://app.mayhem.security |

### Continuing on error

Expand All @@ -117,7 +118,7 @@ jobs:
run: ./run_your_api.sh &
- name: Run Mayhem for API to check for vulnerabilities
uses: ForAllSecure/mapi-action@v2
uses: ForAllSecure/mapi-action@v1
continue-on-error: true # <-----------------------------------------------
with:
mayhem-token: ${{ secrets.MAYHEM_TOKEN }}
Expand Down Expand Up @@ -151,7 +152,7 @@ To create an artifact of the report in your build, add this step to your pipelin

```yaml
- name: Run Mayhem for API to check for vulnerabilities
uses: ForAllSecure/mapi-action@v2
uses: ForAllSecure/mapi-action@v1
continue-on-error: true
with:
mayhem-token: ${{ secrets.MAYHEM_TOKEN }}
Expand Down Expand Up @@ -180,7 +181,7 @@ step to your pipeline:

```yaml
- name: Run Mayhem for API to check for vulnerabilities
uses: ForAllSecure/mapi-action@v2
uses: ForAllSecure/mapi-action@v1
continue-on-error: true
with:
mayhem-token: ${{ secrets.MAYHEM_TOKEN }}
Expand Down

0 comments on commit d86ef18

Please sign in to comment.