This add-on is operated by Sqreen

Powerful security solution made for developers. Protect your app and users

Sqreen

Last updated 23 May 2017

Sqreen is a protection platform for web applications. Sqreen instantly detects and blocks malicious requests and identifies which user accounts are performing these attacks.

Built with developers in mind, Sqreen provides stack traces and other actionable information to help you remedy security issues quickly and easily.

The Sqreen client library runs alongside your application code and introduces no network latency. Using Sqreen doesn’t require code modification or traffic redirection.

Sqreen client libraries are available for Ruby, Python, and Node.js.

Provisioning the add-on

Sqreen can be attached to a Heroku application via the CLI:

$ heroku addons:create sqreen
-----> Adding sqreen to sharp-mountain-4005... done, v18 (free)

When using Sqreen with Heroku, you should use config vars to configure Sqreen whenever possible. The SQREEN_TOKEN config var is set for your app automatically when you provision the add-on. It is the credential required to access Sqreen services.

Using Sqreen with Ruby

Sqreen is compatible with most popular Ruby web frameworks. See Ruby agent compatibility to ensure that it is compatible with your app.

If you have a Ruby on Rails app, add the following entry to your Gemfile:

gem 'sqreen'

Then update your app’s dependencies by running bundle install.

For more information on configuring the Sqreen client library, see Advanced Configuration in Ruby.

When using Sqreen with Heroku, you should use config vars to configure Sqreen whenever possible. The SQREEN_TOKEN config var is set for your app automatically when you provision the add-on.

If your application uses the Devise framework, Sqreen automatically detects and protects user accounts with the DatabaseAuthenticatable strategy. To instead create a manual integration with the Sqreen SDK, see the SDK Documentation.

Using Sqreen with Python

Sqreen is compatible with most popular Python web frameworks. See Python agent compatibility to ensure that it is compatible with your app.

Install the Sqreen Python client library with the following command:

$ pip install sqreen

Then, in your application’s root directory, modify your application file (typically wsgi.py or app.py) by adding the following lines to the (very) top:

import sqreen
sqreen.start()

For more information on configuring the Sqreen client library, see Advanced Configuration in Python.

When using Sqreen with Heroku, you should use config vars to configure Sqreen whenever possible. The SQREEN_TOKEN config var is set for your app automatically when you provision the add-on.

Sqreen automatically detects and protects user accounts for Python applications running Django 1.6 and later. To instead create a manual integration with the Sqreen SDK, see the SDK Documentation.

Using Sqreen with Node.js

Sqreen is compatible with most popular Node.js web frameworks. See Node.js agent compatibility to ensure that it is compatible with your app.

Install the Sqreen Node.js client library with the following command:

$ npm install --save sqreen

Then, in your application’s root directory, edit your main script and require the Sqreen client library at the top (or after New Relic if you are using it):

require('sqreen');

For more information on configuring the Sqreen client library, see Advanced Configuration in Node.js.

When using Sqreen with Heroku, you should use config vars to configure Sqreen whenever possible. The SQREEN_TOKEN config var is set for your app automatically when you provision the add-on.

Sqreen automatically detects and protects user accounts for Node.js apps that use both passport-local version 1.0 or later and passport-http version 0.3 or later for authentication. To instead create a manual integration with the Sqreen SDK, see the SDK Documentation.

The Sqreen dashboard

The Sqreen dashboard provides a bird’s-eye view of your application security. You can view:

• A list of Sqreen Pulses, which identify security activities that require action
• The protection status of your application
• A list of at-risk users, along with those actively attacking your application
• Suspicious user account activity, including shared accounts and accounts using Tor
• HTTP Errors caused by security activity
• A summary of the security of your third-party dependencies
• A map displaying the source of the attacks your app is facing

You can access the dashboard via the CLI:

$ heroku addons:open sqreen
Opening sqreen for sharp-mountain-4005

or by visiting the Heroku Dashboard and selecting the application in question. Select Sqreen from the Add-ons menu.

Migrating between plans

Use the heroku addons:upgrade command to migrate to a new plan.

$ heroku addons:upgrade sqreen:newplan
-----> Upgrading sqreen:newplan to sharp-mountain-4005... done, v18 ($49/mo)
       Your plan has been updated to: sqreen:newplan

Removing the add-on

You can remove Sqreen via the CLI:

$ heroku addons:destroy sqreen
-----> Removing sqreen from sharp-mountain-4005... done, v20 (free)

Support

All Sqreen support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome at hey@sqreen.io.