yshmarov/livechat

これは何？

主な機能

• 01訪問者がどのページからでも開けるチャットバブルウィジェット。未読バッジと下書きの保存に対応。
• 02未対応・解決済みのフィルター、検索、返信ごとの投稿者表示を備えたチーム用受信箱。
• 03デフォルトではポーリングによるリアルタイム更新に対応し、オプションでAction Cableによるプッシュ通知も利用可能。
• 04未読の期間ごとにまとめられる双方向のメール通知。
• 05アクセス制御付きでエンジン経由で配信される、Active Storageを使ったファイル添付。
• 06認可、訪問者の識別、Slack通知などのフックを設定可能。

ユースケース

• SaaSアプリ内で、請求、オンボーディング、アカウントに関する質問に回答する。
• 顧客ポータルから、注文、請求書、予約について顧客が質問できるようにする。
• 管理画面から、社内の管理ユーザーがサポート担当者に直接問い合わせられるようにする。
• 現在の注文やレコードの情報をチャットにあらかじめ入力する、状況に応じたサポートボタンを追加する。

クイックスタート

1. 1

   Gemfile に gem を追加する

2. 2

   bundle をインストールする

   bundle install
3. 3

   インストーラーのジェネレーターを実行する

   bin/rails generate livechat:install
4. 4

   データベースのマイグレーションを実行する

   bin/rails db:migrate

使う前に知っておきたいこと

• !Ruby on Rails アプリでのみ動作します（Ruby >= 3.2、Rails >= 7.1、< 9）。
• !inbox はデフォルトで開発環境のみで有効なため、デプロイ前に authorize_agent を設定する必要があります。

収録されている特集

トピック

よくある質問

livechat とは？

Railsアプリ向けのセルフホスト型ライブチャット。サポートウィジェットとチーム用受信箱を備え、会話データは自分のデータベースに保存します。 livechatは、Railsアプリにアプリ内サポート用のメッセージ機能を追加するRuby gemです。チャットバブルから、訪問者は困ったページ上で質問でき、チームは/livechatにマウントされた受信箱から回答できます。会話、メッセージ、添付ファイルはホストアプリのデータベースに保存されるため、サードパーティのサービスや外部スクリプトは必要ありません。

livechat は無料で使えますか？ライセンスは？

livechat は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

livechat は今もメンテナンスされていますか？

活発にメンテナンス中。livechat の最終コミットは 2026年10月27日 です。

livechat は何に使えますか？

SaaSアプリ内で、請求、オンボーディング、アカウントに関する質問に回答する。 顧客ポータルから、注文、請求書、予約について顧客が質問できるようにする。 管理画面から、社内の管理ユーザーがサポート担当者に直接問い合わせられるようにする。 現在の注文やレコードの情報をチャットにあらかじめ入力する、状況に応じたサポートボタンを追加する。

livechat のインストール方法は？

Gemfile に gem を追加する bundle をインストールする: bundle install インストーラーのジェネレーターを実行する: bin/rails generate livechat:install データベースのマイグレーションを実行する: bin/rails db:migrate

livechat はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/yshmarov/livechat