README.md

traq-system-bot

traQ のシステムBOTです。

以下のイベントの通知を、設定したチャンネルに行います。

• ユーザーの加入 (USER_CREATED)
• ユーザーの再加入 (USER_ACTIVATED)
• チャンネルの作成 (CHANNEL_CREATED)
• スタンプの作成 (STAMP_CREATED)

設定方法

推奨: bot-console を事前に設置すること。

1. (bot-console) 特権を持った（privileged）BOTをWebSocket Modeで作成する。
2. (bot-console) 上記のイベント購読設定を行う。
3. 本BOTを、下記の環境変数を設定してデプロイする。
   • 本リポジトリが公開するDockerイメージ を使うと楽。
   • 最新バージョンはGitHubのリリースページを確認してください。

環境変数

• BOT_SYSTEM_MESSAGE_CHANNEL_ID: 通知メッセージを投稿したいチャンネルのUUID。
• TRAQ_ORIGIN: 接続するtraQインスタンスのURL。WebSocketプロトコルを使用。例: wss://q.trap.jp
• BOT_ACCESS_TOKEN: Botのアクセストークン。