-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# 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のアクセストークン。 |