Skip to content

Commit

Permalink
ServerConnectionReport: ドキュメントの更新
Browse files Browse the repository at this point in the history
設定ファイルの書き方などが変わったため、ドキュメントを更新した。
各IRCデーモン向けに章を分けた。
  • Loading branch information
koi-chan committed May 8, 2015
1 parent 25f9484 commit e441482
Showing 1 changed file with 47 additions and 3 deletions.
50 changes: 47 additions & 3 deletions doc/plugins/server_connection_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,62 @@ ServerConnectionReport
======================

IRC サーバの接続状態の変化を報告するプラグインです。

接続先の「&SERVER」チャンネルに書き込まれるメッセージを監視して IRC サーバの接続状態の変化を検知しています。
お使いのIRCデーモンに合わせて有効化するものを選択してください。

設定
----

設定ファイルのプラグインリストに、以下を追加します。

```yaml
Plugins:
- ServerConnectionReport::NgIRCd
- ServerConnectionReport::Charybdis
- ServerConnectionReport::AthemeServices
```

ngIRCd
------
接続先の「&SERVER」チャンネルに書き込まれるメッセージを監視して IRC サーバの接続状態の変化を検知しています。

設定ファイルに以下を追加して、プラグインの設定を行います。

```yaml
# サーバーリレー監視プラグインの設定
ServerConnectionReport:
ServerConnectionReport::NgIRCd
# NOTICE を行なうチャンネルの一覧
ChannelsToSend:
- '#cre'
```

Charybdis
---------

charybdis は、初期設定ではIRCサーバーオペレータ権(Oper)を持っている人に、サーバーメッセージで接続・切断などのステータスを送信するようになっています。
このサーバーメッセージを検知します。

設定ファイルに以下を追加して、プラグインの設定を行います。

```yaml
# Charybdis 用サーバーリレー監視プラグインの設定
ServerConnectionReport::Charybdis:
# NOTICE を行うチャンネルの一覧
ChannelsToSend:
- ''
```

Atheme-Services
---------------

Atheme-Services を利用している環境であれば、IRCデーモンの種類を問わず子のプラグインでサーバーの接続状態を検知できます。
初期設定では #services チャンネルに情報が出力されます。RGRB がこのチャンネルに参加している必要があります。

設定ファイルに以下を追加して、プラグインの設定を行います。

```yaml
# Atheme-Services 用サーバーリレー監視プラグインの設定
ServerConnectionReport::AthemeServices:
# NOTICE を行うチャンネルの一覧
ChannelsToSend:
- ''
```

0 comments on commit e441482

Please sign in to comment.