https://github.com/traptitech/traq-system-bot

https://github.com/traptitech/traq-system-bot

traq

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/traptitech/traq-system-bot
• Owner: traPtitech
• Created: 2019-09-08T14:14:08.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T09:57:37.000Z (almost 2 years ago)
• Last Synced: 2025-02-02T13:51:54.991Z (over 1 year ago)
• Topics: traq
• Language: Go
• Homepage:
• Size: 43.9 KB
• Stars: 0
• Watchers: 10
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# traq-system-bot

[![GitHub release](https://img.shields.io/github/release/traPtitech/traq-system-bot.svg)](https://github.com/traPtitech/traq-system-bot/releases/)

[traQ](https://github.com/traPtitech/traQ) のシステムBOTです。

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

- ユーザーの加入 (`USER_CREATED`)

- ユーザーの再加入 (`USER_ACTIVATED`)

- チャンネルの作成 (`CHANNEL_CREATED`)

- スタンプの作成 (`STAMP_CREATED`)

## 設定方法

推奨: [bot-console](https://github.com/traPtitech/traQ-bot-console) を事前に設置すること。

1. (bot-console) 特権を持った（`privileged`）BOTをWebSocket Modeで作成する。

2. (bot-console) 上記のイベント購読設定を行う。

3. 本BOTを、下記の環境変数を設定してデプロイする。

    - [本リポジトリが公開するDockerイメージ](https://github.com/traPtitech/traq-system-bot/pkgs/container/traq-system-bot) を使うと楽。

    - 最新バージョンはGitHubのリリースページを確認してください。

### 環境変数

- `BOT_SYSTEM_MESSAGE_CHANNEL_ID`: 通知メッセージを投稿したいチャンネルのUUID。

- `TRAQ_ORIGIN`: 接続するtraQインスタンスのURL。WebSocketプロトコルを使用。例: `wss://q.trap.jp`

- `BOT_ACCESS_TOKEN`: Botのアクセストークン。