Skip to content

Commit

Permalink
Update README for Admin Notification Feature
Browse files Browse the repository at this point in the history
  • Loading branch information
pykettk committed Apr 26, 2023
1 parent 6164edd commit 5ffb26a
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,20 +62,20 @@ The Sansec Composer integrity scan can be disabled by setting this option to `No

<br>

### Match Percentage Threshold for Notification
This option is only considered when integrity failure emails are enabled. The value specified here determines the
minimum match percentage required for the integrity checks to be considered successful. Admins will be notified of any
packages that fail to meet this number.

<br>

### Report Integrity Failures by Email
Allow emails to be sent when the Sansec Composer integrity checker finds discrepancies with your dependency files.
This feature is disabled by default but can be enabled by setting this option to `Yes`. Once enabled you will be able
to configure a threshold for dependency matching as well as a list of email address to notify when a failure occurs.

<br>

### Match Percentage Threshold for Notification
This option is only considered when integrity failure emails are enabled. The value specified here determines the
minimum match percentage required for the integrity checks to be considered successful. Admins will be notified of any
packages that fail to meet this number.

<br>

### Report Errors To
This option is only considered when integrity failure emails are enabled. These dynamic rows allow you to configure a
series of email addresses that should be notified when packages fail to meet the configured threshold.
Expand All @@ -93,5 +93,10 @@ series of email addresses that should be notified when packages fail to meet the

<br>

### Admin Notification
![admin-notification](https://user-images.githubusercontent.com/40261741/234433383-c30d133c-bcde-480f-8faa-20b1ae13a523.png)

<br>

### Example Email Notification
![email-example](https://user-images.githubusercontent.com/40261741/234102797-8937df5a-7312-4750-a9ca-09c2ad7379bd.png)

0 comments on commit 5ffb26a

Please sign in to comment.