Skip to content

Commit

Permalink
Update Admin Options Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pykettk authored May 18, 2023
1 parent 5960815 commit cf742ab
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

✔️ Email and admin notifications for packages that do not meet your desired integrity rating

✔️ Configure a safe list to reduce the noise generated by the scanner

✔️ Supports Magento Open Source and Adobe Commerce

✔️ Theme agnostic
Expand All @@ -28,9 +30,10 @@ composer require element119/module-sansec-composer-integrity-checker
php bin/magento setup:upgrade
```

It is also recommended that you enable the scans and lock the related config value as a post-installation step:
### Post-Installation Steps
It is also recommended that you enable the scans and lock the related config value:
```bash
php bin/magento config:set --lock-env system/sansec_composer_integrity_checker/scan_enable 1
php bin/magento config:set --lock-config system/sansec_composer_integrity_checker/scan_enable 1
```

<br/>
Expand Down Expand Up @@ -90,9 +93,44 @@ series of email addresses that should be notified when packages fail to meet the

<br>

### Enable Package Ignore List
Allows specified packages to be removed from various reporting channels. This feature is disabled by default but can
be enabled by setting this option to `Yes`.

<br>

### Ignored Packages
This option is only considered when the package ignore list is enabled. These dynamic rows allow you to configure a
set of packages that should be ignored for various reporting channels. The values expected here are the Composer
package names in the format `vendor/package-name`.

<br>

### Remove Ignored Packages from Admin Grid
This option is only considered when the package ignore list is enabled. This feature is disabled by default but can
be enabled by setting this option to `Yes`. When enabled, ignored packages will be removed from the admin grid.

<br>

### Remove Ignored Packages from Admin Notifications
This option is only considered when the package ignore list is enabled. This feature is disabled by default but can
be enabled by setting this option to `Yes`. When enabled, ignored packages will not be considered when determining
whether to display the admin notification and the number of packages it reports as having failed to meet the
threshold.

<br>

### Remove Ignored Packages from Email Notifications
This option is only considered when email notifications are enabled **and** when the package ignore list is enabled.
This feature is disabled by default but can be enabled by setting this option to `Yes`. When enabled, ignored
packages will be removed from email notifications.

<br>

## 📸 Screenshots & GIFs
### Admin Configuration
![admin-config](https://user-images.githubusercontent.com/40261741/234102715-ed9e584e-da61-4a0f-9ae3-9f72bdde5524.png)
![admin-config](https://github.com/element119/module-sansec-composer-integrity-checker/assets/40261741/10f42c1a-adef-44f7-9390-1db9315d3ea7)


<br>

Expand Down

0 comments on commit cf742ab

Please sign in to comment.