Configuring BugHerd

Background

BugHerd is a tool that makes it super easy for users to report any feedback or issues they encounter while using a website. It allows the user to pinpoint parts of the page that are causing an issue and attach screenshots, all within the OFN website.

Configuring BugHerd

By default, BugHerd is disabled. To enable it for your OFN instance, follow these instructions.

  1. Sign up for a BugHerd account, and start a BugHerd project for your OFN instance.
  2. Find your BugHerd API key. It can be found by clicking the cog near the top-left of the BugHerd screen, then clicking “install bugherd”. Copy the ‘Product Key’.

  3. Log in to the OFN admin interface as SuperAdmin. Click on Configuration in the main menu, then General Settings.
  4. Fill in your copied ‘Product Key’ in the “BugHerd API key” field. Click Update.
  5. Verify your configuration. Visit your OFN site, and you should see a “Send Feedback” link at the bottom-right of the screen. Alternatively, if you are logged into BugHerd, you will see a left arrow that opens the BugHerd sidebar in the same location. Log some feedback and it should appear in your BugHerd account.

I tried setting up BugHerd yesterday for openfoodnetwork.no as per these instructions. It did not work as expected…

We had problems with v1.6 and rolled back to v1.5. @sigmundpetersen is back next week and will move us up to 1.7.
Could this be the reason I had a hard time?
Also saw @Kirsten message on github… have I hijacked something?

Hi @CynthiaReynolds,

What problems did you encounter? This feature is not quite released yet - it’s on Aus production, and will be released in version 1.7.1, which is due on Friday (in a week’s time).

Ping @lin_d_hop - here are setup instructions for BugHerd once UK is on 1.7.1.