At GuardRails, we focus on security that doesn't get in your way. That means supporting a quick and easy installation, without any additional configuration.
Nonetheless, we understand that one size doesn't fit all. A great developer experience requires flexibility to configure GuardRails to your needs.
You can override the default configuration for your account/organization in the Settings tab of the dashboard. By default, the config is:
bundles: "auto" report: pullRequest: findings: "onChangedLinesOnly" comment: true notifications: slack: enabled: false
Bundles are set of tools we use to detect security issues in repositories, typically grouped by programming language.
Currently, we support the following bundles:
By default, we run the
general bundle, along with the bundle(s) matching the language(s) we detect in your repository.
It may happen that we don't detect (all) the language(s) of your repository. In that case you can override the
bundles attribute to serve your needs:
You can even go further by overriding the tools that run within a bundle:
This will run the full
General bundle, along with just the Mythx tool from the
Solidity bundle (which by default runs both
Solhint). To know more about the tools of a bundle, please refer to the Tools section.
Here are all the possibilities:
This attribute enables you to control the behavior of GuardRails in your pull requests. Per default, we only notify you of security issues detected in the lines that changed in your pull requests (
true (default) or
By default, we post a comment in your pull requests if we find any security issues. If you prefer to review the reports via our dashboard and want to disable the comments, set this attribute to
In order to enable Slack notifications for GuardRails, you first have to set up incoming Webhooks for Slack. There are 6 steps to follow:
- Create a (Slack app)[https://api.slack.com/apps/new] (if you don't already have one).
Incoming Webhooksfrom the settings page.
- After the settings page refreshes, click
Add New Webhook to Workspace.
- Pick a channel that the app will post to, then click
- Copy the value of the Incoming Webhook URL
- Configure GuardRails:
notifications: slack: notify: whenScanHasFindingsOnly enabled: true webhookUrl: >- https://hooks.slack.com/services/XXXXXXXXX/YYYYYYYYY/xyxyxyxyxyxyxyxyxyxyxyxy
A valid URL corresponding to a Slack Incoming Webhook.
Ignoring files and folders
The ignore file can come handy if you notice GuardRails is alerting you on some code you deliberately know is vulnerable, or causes false positives. The ignore file follows the gitignore file pattern. Refer to the gitignore docs for more details. One example file is:
If you want to disable one line in particular, you need to add
guardrails-disable-line on the concerned line, usually as a comment.
const highEntropyStringThatIsNotASecret = "e32kdjksw'(&dej+"; // guardrails-disable-line