GuardRails Guide: Installation & Usage¶
GuardRails is a service that provides continuous security feedback for your GitHub repositories.
What is GuardRails?¶
GuardRails makes open-source security tools easily available in your GitHub pull requests. It has been tuned to keep the noise low and only report high-impact and relevant security issues.
Installing and configuring security tools, even for one repository, typically takes a lot of time and effort. GuardRails makes that process painless and rewarding for developers.
GuardRails can be installed across all your repositories in minutes. Once installed, GuardRails identifies security problems in your codebase and helps you fix them.
In addition, GuardRails leverages the power of MythX in order to scan for security vulnerabilities in your smart contracts.
To view to latest setup instructions for GuardRails, please see their Getting Started page.
The free version of GuardRails only works with public repositories.
MythX comes built-in to GuardRails integration; no special installation is required.
By default GuardRails will decide how to analyze based on the code tag on the repository. Solidity isn’t always caught correctly, but you can set the bundle setting default to solidity in the Dashboard.
Once GuardRails is properly configured, whenever a pull request is created on a branch, GuardRails will start a scan in the comments. This scan may take some time, especially if you have multiple languages or multiple smart contracts.
When completed, you will see the results of the scan in the pull request:
You can see more detailed information about the issue and where it came from by clicking Details to see the scan report in the GuardRails dashboard: