Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby JavaScript CSS
branch: master

version bump

latest commit 13c1a07e05
Vincent Brendel authored
Failed to load latest commit information.
lib version bump
test pass config into widget
.gitignore ignore
Gemfile version bump
Gemfile.lock version bump
MIT-LICENSE initial gem with helper
README.md Update README.md
Rakefile initial gem with helper
bugherd.gemspec updated dependencies for rails4

README.md

BugHerd gem

Add the BugHerd widget to your Rails site. Get a BugHerd account.

Installation

Add the following to your Gemfile:

gem "bugherd"

...and then run bundle.

Add a file config/initializers/bugherd.rb containing:

BugHerd.configure do |config|
  config.project_key = 'YOUR KEY HERE'
end

Alternatively you can set an environment variable called BUGHERD_PROJECT_KEY.

You can obtain the project key from your project's installation options in BugHerd.

Now add to the head tag in your layout(s):

<%= bugherd_tag %>

If you use turbolinks, please be sure to use this instead:

<%= bugherd_turbolinks_tag %>

Meta data

BugHerd allows you to pass in extra data which will be added as metadata to any bug your users may log on the page where the widget is rendered.

<%= bugherd_tag metadata: { user_id: current_user.id.to_s, controller: controller.controller_name } %>

Pre-populate email addresses

If your site has logged in users and you use public feedback, have the email addresses pre-populated:

<%= bugherd_tag reporter: { email: current_user.email, required: "true" } %>
Something went wrong with that request. Please try again.