← Back to Home

Frequently Asked Questions

Account Registration & Login
  • You can sign in with Google or GitHub OAuth. No email/password registration is required.
  • You can log in with both a Google account and a GitHub account linked to the same email address (accounts are automatically linked).
Creating a Project
  • Click the "New Project" button on the dashboard to create a project.
  • Set a project name and a URL-friendly slug. The slug is used as the project identifier.
Embedding the Widget
  • Copy the embed code shown on your project's settings page.
  • Add the copied '<script>' tag to the end of your site''s '<body>'.
  • The data-api-key attribute contains your project's unique API key. Do not modify this value.
  • Add the origin of the site where the widget is installed (e.g., https://example.com) to "Allowed Origins" in the settings page. This is used for CORS control.
Setting Up GitHub Integration
  • Click the "Install GitHub App" button in the "GitHub Integration" section of your project settings.
  • You'll be redirected to GitHub. Install the Bugoon App and grant access to the repositories where you want Issues created.
  • After installation, you'll be redirected back to the dashboard. Enter the target repository name in owner/repo format (e.g., myorg/my-app) in the "Repository" field and save.
  • In the "GitHub Labels" section, you can customize the labels applied to auto-created Issues. Leave empty to skip a label.
  • Once configured, bug reports will automatically create GitHub Issues. No token expiration to worry about.
Inviting Members
  • Project owners can invite members by entering their email address in the "Members" section of the settings page.
  • If the invited user already has a Bugoon account, they can join immediately. If not registered, they will automatically join the project on their next login.
  • Owners can change project settings, delete the project, and manage members. Members can view bug reports and update their status.
Security
  • API keys are uniquely generated for each project. You can view them in the settings page, but do not share them with third parties.
  • GitHub integration uses the GitHub App method. No user tokens are stored on the server. GitHub App credentials are securely managed on the server side.
  • Widget requests are only accepted from domains registered in "Allowed Origins" (CORS control). Requests from unauthorized origins are blocked.
Screenshot Methods
  • In "Auto (Recommended)" mode, if the Bugoon Chrome extension is installed, screenshots are captured pixel-perfectly via the extension. Otherwise, it falls back to DOM rendering (html-to-image).
  • In "Screen Sharing" mode, the browser's Screen Capture API is used. A dialog prompts you to select a screen, but it accurately captures CORS images, iframes, Canvas/WebGL, and other elements that DOM rendering cannot handle.
  • You can select the screenshot method in the embed code section of the project settings page. It is controlled by the data-capture attribute on the script tag.
  • "Auto" works well for most sites, but try "Screen Sharing" mode for sites with many external images or embedded content.
Chrome Extension
  • Install the Bugoon Screenshot extension for pixel-perfect screenshots captured via the browser''s native API.
  • The widget works without the extension using DOM rendering (html-to-image). The extension is an optional upgrade for screenshot quality.
  • Install from the Chrome Web Store: https://chromewebstore.google.com/detail/gbfcojmjpgijmdpccdmppnbagflgjphl
  • The extension only uses activeTab and host_permissions. It does not collect or transmit any data. Screenshots are passed directly to the widget within the browser.