よくある質問(FAQ)
アカウント登録・ログインについて
- •Google または GitHub の OAuth でサインインできます。メールアドレスとパスワードの登録は不要です。
- •同じメールアドレスなら、Google と GitHub のどちらでもログインできます。アカウントは自動的にリンクされます。
プロジェクトの作成方法
- •ダッシュボードの「新規プロジェクト」ボタンからプロジェクトを作成できます。
- •プロジェクト名と、URL 用の名前(スラッグ)を決めてください。URL 用の名前は、ダッシュボードのアドレスに使われます。
ウィジェットの埋め込み方法
- •プロジェクトの設定画面に表示される埋め込みコードをコピーしてください。
- •コピーした <script> タグをサイトの <body> 末尾に追加します。
- •data-api-key 属性にはプロジェクト固有の API キーが設定されています。この値は変更しないでください。
- •設定画面の「ウィジェットを置くサイト」に、設置先のアドレス(例: https://example.com)を追加してください。ここに書いたサイトからの報告だけを受け付けます。別のサイトからの通信を制限するブラウザの仕組み(CORS)を使っています。
GitHub 連携の設定方法
- •プロジェクト設定画面の「GitHub 連携」を開きます。「GitHub App をインストール」ボタンを押してください。
- •GitHub の画面に移ったら Bugoon App をインストールします。Issue を作りたいリポジトリへのアクセスを許可してください。
- •インストールが終わると、自動的にダッシュボードに戻ります。「リポジトリ」欄に Issue の作成先を入力します。owner/repo の形(例: myorg/my-app)で入力し、保存してください。
- •「GitHub ラベル」セクションで、自動作成される Issue に付与するラベルをカスタマイズできます。空欄にするとそのラベルはスキップされます。
- •設定完了後、バグレポートが送信されると GitHub Issue が自動的に作成されます。トークンの期限管理は不要です。
メンバー招待について
- •プロジェクトのオーナーは、設定画面の「メンバー管理」セクションからメールアドレスを入力してメンバーを招待できます。
- •招待されたユーザーが既に Bugoon にアカウントを持っている場合は即座に参加できます。未登録の場合は、次回ログイン時に自動的にプロジェクトに参加します。
- •オーナーはプロジェクトの設定変更・削除・メンバー管理が可能です。メンバーはバグレポートの閲覧・ステータス更新ができます。
セキュリティについて
- •API キーはプロジェクトごとに一意に生成されます。設定画面で確認できますが、第三者に共有しないでください。
- •GitHub 連携は GitHub App 方式を採用しており、ユーザーのトークンをサーバーに保存しません。GitHub App の認証情報はサーバー側で安全に管理されています。
- •「ウィジェットを置くサイト」に登録したサイトからの報告だけを受け付けます。登録していないサイトからの送信はブロックされます。
スクリーンショット方式について
- •「自動(推奨)」モードでは、Bugoon Chrome 拡張があれば拡張経由で撮ります。ピクセルパーフェクトなスクリーンショットになります。拡張がない場合は DOM 描画(画面を組み直して画像にする方式、html-to-image)に切り替わります。
- •「画面共有」モードでは、ブラウザの Screen Capture API を使います。ダイアログで画面を選ぶ操作が必要です。ただし他サイトの画像・iframe・Canvas/WebGL など、DOM 描画では撮れない要素も正確に撮れます。
- •スクリーンショット方式はプロジェクト設定画面の埋め込みコードセクションで選択できます。スクリプトタグの data-capture 属性で制御されます。
- •大半のサイトでは「自動」で問題ありません。外部画像や埋め込みコンテンツが多いサイトでは「画面共有」モードをお試しください。
Chrome 拡張機能について
- •Bugoon Screenshot 拡張を入れると、スクリーンショットがブラウザのネイティブ API 経由で撮られます。ピクセルパーフェクトな画像になります。
- •拡張がなくてもウィジェットは DOM 描画(html-to-image)で動作します。拡張はスクリーンショット品質の向上のためのオプションです。
- •Chrome ウェブストアからインストールできます: https://chromewebstore.google.com/detail/gbfcojmjpgijmdpccdmppnbagflgjphl
- •拡張は activeTab と host_permissions のみを使用し、データの収集・送信は一切行いません。スクリーンショットはブラウザ内でウィジェットに渡されるだけです。
CSP(Content Security Policy)対応について
- •サイトで CSP ヘッダーを設定している場合は、以下のディレクティブを追加してください。Bugoon ウィジェットが正しく動作するために必要です。
- •script-src にウィジェット JS の配信元オリジン(例: https://bugoon.com )を追加してください。
- •connect-src にウィジェットの配信元オリジン(バグレポート送信 API)を追加してください。スクリーンショットのアップロード先として https://firebasestorage.googleapis.com も追加します。
- •style-src: 'unsafe-inline' を追加してください。ウィジェットは Shadow DOM 内でインラインスタイルを使用しますが、親サイトの DOM には影響しません。
- •プロジェクト設定画面の「AI導入プロンプト」には CSP の修正手順も入っています。Claude Code や Cursor に渡すだけで、CSP の設定も含めて自動で導入できます。
GitHubラベルの設定について
- •プロジェクト設定画面の「GitHubラベル」セクションを開きます。自動作成される GitHub Issue に付けるラベルを変更できます。
- •「common」はすべての Issue に共通で付与されるラベルです。デフォルトは「bug」です。
- •報告者がウィジェットで選んだ深刻度に合わせて、severity: で始まるラベルが 1 つ付きます。値は critical / major / minor / trivial のいずれかです。
- •「console_errors」はコンソールエラーを含むレポートに付きます。「network_errors」はネットワークエラーを含むレポートに付きます。
- •各ラベルの値を空欄にすると、そのラベルは Issue に付与されません。不要なラベルを無効化する場合に使用してください。
- •ラベルは GitHub リポジトリに事前に作成しておく必要があります。存在しないラベルを指定した場合、Issue 作成時にラベルが付与されないことがあります。
Slack連携の設定方法
- •プロジェクト設定画面の「Slack連携」セクションから設定します。Webhook モードと Bot モードのどちらかを選んでください。
- •Webhook モードで使うのは、Slack の通知用 URL(Incoming Webhook)だけです。貼り付ければ設定は終わります。バグレポートが作られるたびに通知が届きます。
- •Bot モードでは、Slack App を OAuth でインストールします。バグレポート作成時の通知に加え、ステータス変更や GitHub Issue 作成時にもスレッド返信で通知されます。
- •Webhook URL は Slack で発行します。ワークスペースの「設定と管理」>「アプリを管理」で Incoming Webhooks を有効にしてください。通知先チャンネルを選ぶと URL が出るので、コピーしてください。
- •Bot モードでは通知がスレッド形式で送られます。1 つのバグレポートに関する更新がまとまるので、チャンネルが散らかりません。
- •連携はいつでも設定画面の「連携を解除」ボタンから解除できます。解除すると通知は停止しますが、既存のバグレポートデータには影響しません。
Notion連携の設定方法
- •プロジェクト設定画面の「Notion連携」セクションから設定します。OAuth モードと Token モードのどちらかを選んでください。
- •OAuth モードでは、「Notionに接続」ボタンをクリックすると Notion の認証画面に遷移します。認証完了後、アクセス可能なデータベースの一覧が表示されるので、同期先のデータベースを選択してください。
- •Token モードでは、トークンとデータベース ID を手で入力します。トークンは Notion の Internal Integration Token です。Notion の「Settings & members」を開いてください。「Connections」で Integration を作ります。
- •Token モードでは、作成した Integration を対象データベースに接続します。データベースの「...」メニュー >「Connections」から接続してください。データベース ID は、データベースページの URL に含まれる 32 文字の英数字です。
- •設定が終わると、バグレポートが作られるたびに Notion データベースへページが追加されます。Bugoon はデータベースのプロパティ構造を自動で調べ、一致するプロパティにだけ同期します。対応するプロパティと型は次のとおりです。タイトルは title型(自動検出)。Status/ステータスは status型か select型。Severity/重要度は select型。Page URL/URL と Dashboard Link/Bugoon は url型。Browser/ブラウザ と OS は rich_text型。これらが無い場合はスキップされるので、タイトルだけあれば動きます。
- •ダッシュボードでステータスを変えると、対応する Notion ページのステータスも自動で更新されます。
- •連携はいつでも設定画面の「連携を解除」ボタンから解除できます。解除すると自動同期は停止しますが、既存のバグレポートデータや Notion ページには影響しません。
MCP サーバー(AI連携)
- •MCP サーバーを使うと、Claude Code などの AI ツールからバグ情報に直接アクセスできます。バグ一覧の取得、詳細の確認、ステータス更新をエディタから離れずに行えます。
- •npm パッケージ名は @rubyjobs-jp/bugoon-mcp-server です。npx 経由で実行されるため、手動インストールは不要です。
- •セットアップ手順: (1) プロジェクト設定画面でシークレットキーをコピーします。(2) お使いの IDE の設定ファイルに MCP サーバーの設定を追加します。
- •Claude Code の場合: プロジェクトルートの .mcp.json に以下の設定を追加してください。BUGOON_SECRET_KEY にはコピーしたシークレットキーを設定します。
{ "mcpServers": { "bugoon": { "command": "npx", "args": ["-y", "@rubyjobs-jp/bugoon-mcp-server"], "env": { "BUGOON_SECRET_KEY": "YOUR_SECRET_KEY", "BUGOON_API_URL": "https://bugoon.com" } } } } - •Cursor の場合: .cursor/mcp.json に以下の設定を追加してください。
{ "mcpServers": { "bugoon": { "command": "npx", "args": ["-y", "@rubyjobs-jp/bugoon-mcp-server"], "env": { "BUGOON_SECRET_KEY": "YOUR_SECRET_KEY", "BUGOON_API_URL": "https://bugoon.com" } } } } - •利用可能な機能: バグレポート一覧の取得、バグレポート詳細の取得、ステータスの更新、プロジェクト情報の取得など。AI がバグの内容を理解し、修正作業に活用できます。
- •使用例: AI エージェントに以下のように指示できます。
# トリアージのバグ一覧を取得して、ブラウザで確認して、 # 問題があるものは未対応ステータスに変更して # 未対応のバグを取得して、順番に修正して、 # 修正が終わったら解決済みステータスに変更して # バグレポート #42 の詳細を教えて # criticalのバグ一覧を見せて
- •対応ツール: MCP(Model Context Protocol)に対応したすべてのツールで利用可能です。Claude Code、Cursor、その他 MCP 対応エディタ・ツールで動作します。
アプリについて
Bugoon コンパニオンアプリ(iOS / Android)とは?
- •スマホやタブレットでの実機テスト中に使う iOS アプリです。スクリーンショットの共有シートから素早くバグを起票できます。
- •操作は最小限です。画面をスクリーンショット → 共有シートで Bugoon を選択 → プロジェクトを選んで送信。これでバグレポートができます。
- •送信後に届く通知をタップすると、注釈や深刻度などの詳細を後から追記できます。
- •iOS 版は App Store からダウンロードできます: https://apps.apple.com/app/id6781889059
- •Android 版は Google Play からダウンロードできます: https://play.google.com/store/apps/details?id=com.bugoon.companion
アプリの通知が来ない場合
- •まず端末の集中モード(おやすみモード)がオンになっていないか確認してください。集中モードが有効だと通知バナーは表示されず、通知センターにのみ届きます。
- •画面上端から下にスワイプして通知センターを開き、Bugoon の通知が届いていないか確認してください。
- •設定 → 通知 → Bugoon で通知が許可されているか確認してください。設定 → 集中モード で Bugoon が許可アプリに入っているかも確認してください。
- •それでも届かない場合は、アプリを一度起動し直してから、もう一度共有シートで送信してお試しください。