-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38 from creative-commoners/pulls/1/update-readme
Update readme to reflect v1.0 milestone changes
- Loading branch information
Showing
1 changed file
with
20 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,36 @@ | ||
| # [SilverStripe composer security checker](https://github.com/bringyourownideas/silverstripe-composer-security-checker) <br /> [](https://travis-ci.org/bringyourownideas/silverstripe-composer-security-checker) [](https://github.com/bringyourownideas/silverstripe-composer-security-checker/releases) [](https://packagist.org/packages/bringyourownideas/silverstripe-composer-security-checker) [](https://scrutinizer-ci.com/g/bringyourownideas/silverstripe-composer-security-checker?branch=master) [](https://packagist.org/packages/bringyourownideas/silverstripe-composer-security-checker) [](https://github.com/bringyourownideas/silverstripe-composer-security-checker/blob/master/license.md) | ||
| # SilverStripe Security Checker | ||
|
|
||
| Adds a task which runs a check if any of the dependencies has known security vulnerabilities. It uses the | ||
| [SensioLabs Security Check Web service][1] and the [Security Advisories Database][2]. | ||
| [](https://travis-ci.org/bringyourownideas/silverstripe-composer-security-checker) | ||
| [](https://scrutinizer-ci.com/g/bringyourownideas/silverstripe-composer-security-checker/?branch=master) | ||
| [](https://codecov.io/gh/bringyourownideas/silverstripe-composer-security-checker) | ||
|
|
||
| The information is displayed using the [SilverStripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance "supports you with the maintainence of your SilverStripe project"). | ||
| Adds a task which runs a check if any of the dependencies has known security vulnerabilities. It uses the | ||
| [SensioLabs Security Check Web service](http://security.sensiolabs.org/) and the [Security Advisories Database](https://github.com/FriendsOfPHP/security-advisories). | ||
|
|
||
| ### Requirements | ||
| BSD 3-clause [License](https://github.com/bringyourownideas/silverstripe-composer-security-checker/blob/master/license.md) | ||
|
|
||
| * SilverStripe Framework ^3.0 | ||
| * SilverStripe QueuedJobs * | ||
| ## Requirements | ||
|
|
||
| * SilverStripe Framework ^3 | ||
| * SilverStripe QueuedJobs ^2 | ||
|
|
||
| ### Installation | ||
| ### Suggested Module | ||
|
|
||
| The following installation commands includes schedulding a queuedjob to populate the data. Run the following command to install this package as a development dependency: | ||
| This module will automatically amend the SiteSummary report provided by the [SilverStripe Maintenance module](https://github.com/bringyourownideas/silverstripe-maintenance), adding alerts if security updates are present for installed modules. | ||
|
|
||
| ``` | ||
| composer require bringyourownideas/silverstripe-composer-security-checker dev-master --dev | ||
| php ./framework/cli-script.php dev/build | ||
| php ./framework/cli-script.php dev/tasks/ProcessJobQueueTask | ||
| ``` | ||
| ## Installation | ||
|
|
||
| *or* as general dependency: | ||
| The following installation commands includes schedulding a queuedjob to populate the data. Run the following command to install this package as a development dependency: | ||
|
|
||
| ``` | ||
| composer require bringyourownideas/silverstripe-composer-security-checker dev-master | ||
| php ./framework/cli-script.php dev/build | ||
| php ./framework/cli-script.php dev/tasks/ProcessJobQueueTask | ||
| ./framework/sake dev/build | ||
| ./framework/sake dev/tasks/ProcessJobQueueTask | ||
| ``` | ||
|
|
||
| **Recommendation is to only install this as dev dependency!** | ||
|
|
||
|
|
||
| ### Usage | ||
|
|
||
| The information gets automatically updated via a queuedjob on dev/build. You will need to run the queuedjobs task to get the information. | ||
|
|
||
| Use the information in your database (Table "ComposerSecurityVulnerability") as you like. Please be careful how you expose this information. | ||
|
|
||
| ## Usage | ||
|
|
||
| ## MISC: [Future ideas/development, issues](https://github.com/bringyourownideas/silverstripe-composer-security-checker/issues), [Contributing](https://github.com/bringyourownideas/silverstripe-composer-security-checker/blob/master/CONTRIBUTING.md), [License](https://github.com/bringyourownideas/silverstripe-composer-security-checker/blob/master/license.md) | ||
| The information gets updated via a BuildTask, which in turn can be run via a queuedjob. | ||
| You will need to set up a scheduled process (e.g. `cron`) to run either the buildtask directly, or the task to process the queuedjobs queue in order to refresh the information. | ||
|
|
||
| [1]: http://security.sensiolabs.org/ | ||
| [2]: https://github.com/FriendsOfPHP/security-advisories | ||
| Use the information is stored in the `SecurityAlert` object, and can be consumed as needed. Please be careful how you expose this information. If the SilverStripe Maintenance module is present, a relationship will be connected between `Package` and `SecurityAlert`. |