Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.45 KB

install.rst

File metadata and controls

81 lines (55 loc) · 2.45 KB

Installation

Raven is distributed in a few different methods, and should get included after any other libraries are included, but before your own scripts.

So for example:

<script src="jquery.js"></script>
<script src="https://cdn.ravenjs.com/2.0.0/raven.min.js"></script>
<script>Raven.config('___PUBLIC_DSN___').install();</script>
<script src="app.js"></script>

This allows the ability for Raven's integrations to instrument themselves. If included before something like jQuery, it'd be impossible to use for example, the jQuery plugin.

Using our CDN

We serve our own builds off of Fastly. They are accessible over both http and https, so we recommend leaving the protocol off.

Our CDN distributes builds with and without :doc:`integrations <integrations/index>`.

<script src="https://cdn.ravenjs.com/2.0.0/raven.min.js"></script>

We highly recommend trying out a plugin or two since it'll greatly improve the chances that we can collect good information.

This version does not include any plugins. See ravenjs.com for more information about plugins and getting other builds.

Bower

We also provide a way to deploy Raven via bower. Useful if you want serve your own scripts instead of depending on our CDN and mantain a bower.json with a list of dependencies and versions (adding the --save flag would automatically add it to bower.json).

$ bower install raven-js --save
<script src="/bower_components/raven-js/dist/raven.js"></script>

Also note that the file is uncompresed but is ready to pass to any decent JavaScript compressor like uglify.

npm

Raven is published to npm as well. https://www.npmjs.com/package/raven-js

$ npm install raven-js --save

Note that if you intend to use Raven with Node, raven-node is the client to use

Requirements

Raven expects the browser to provide window.JSON and window.JSON.stringify. In Internet Explorer 8+ these are available in standards mode. You can also use json2.js to provide the JSON implementation in browsers/modes which doesn't support native JSON