Warning: Scruin is currently under heavy development and may not yet work as advertised. Use at your own risk.
- Rails 4.2+
- Ruby 2.1+
- PostgreSQL 9.2+
Add the scruin gem to your Rails application's
gem 'scruin', github: 'tonyhburns/scruin', branch: 'master'
TODO: Write configuration instructions here.
TODO: Write usage instructions here.
See the YARD documentation for the latest API documentation.
Generate local documentation with YARD (output to the
$ bin/rake yard
- IRC: #scruin on Freenode [GitHub
- Issues](https://github.com/tonyhburns/scruin/issues) Mailing list:
- Scruin on Google Groups
- Twitter: @scruingem
Scruin is cryptographically signed. To be sure the gem you install hasn't been tampered with, verify the checksum of the signing certificate and add it (if you haven't already) as a trusted certificate:
$ sha256 <(curl -Ls https://raw.github.com/tonyhburns/scruin/master/tonyhburns.pem) $ gem cert --add <(curl -Ls https://raw.github.com/tonyhburns/scruin/master/tonyhburns.pem)
The SHA256 checksum of the signing certificate should be:
Installing the gem with the
MediumSecurity trust profile will verify all signed
gems, but allow the installation of unsigned dependencies:
$ gem install scruin -P MediumSecurity
You can also set the trust file for Bundler:
$ bundle --trust-policy MediumSecurity
MediumSecurity policy is often necessary because not all of your
dependencies may not be signed, so
HighSecurity is not an option.
Reporting security bugs
If you have discovered an issue with Scruin of a sensitive nature that could compromise the security of Scruin users, please disclose it responsibly by following the steps in SECURITY.md.
Development and testing
$ bin/rake lint
$ bin/rake spec
See CONTRIBUTING.md for full information on how to contribute to Scruin.
© 2015 Tony Burns
Distributed under the MIT License. See
LICENSE.txt for details.
The Scruin logo is licensed under CC BY-SA 4.0.