Log Archiver

IRC ボットを常駐させることでチャットログをチャンネル単位で RDBMS に直接記録し、Rails アプリケーションにより記録されたログを整形・表示します。

動作環境

• Linux または OSX
• Ruby 3.2.0 以降
• NodeJS 18.x 以降
• MySQL または MariaDB と Mroonga プラグイン
• Redis

インストール

MariaDB もしくは MySQL と、Redis をインストールしていない場合はインストールしてください。

全文検索機能を動作させるため、Groonga および Mroonga のインストールが必要です。Mroonga 公式サイトよりインストール方法を参照してインストールを行ってください。

Ruby をインストールしていない場合はインストールしてください。

Bundler をインストールしていない場合は以下を実行してください。

gem install bundler

Yarn をインストールしていない場合はインストールしてください。

上記が完了したら、適当なディレクトリにファイルを設置し、以下を実行して必要なライブラリをインストールしてください。

bundle install
corepack enable
yarn install

なお、gem をインストールするためには、システムにいくつかのライブラリと開発環境がインストールされている必要があります。CentOS 7 を最小限構成でセットアップしている場合、以下の追加パッケージが必要です。

• make
• gcc
• gcc-c++
• libicu-devel
• zlib-devel
• mariadb-devel (もしくは mysql-devel)

具体的なインストール手順は インストール を参照してください。

設定

• インストール
• IRC の接続設定
• ウェブサーバの設定
• バックグラウンドジョブの設定

systemd による制御を行なう場合は systemd を参照してください。

IRC ボットの起動

IRC ボットを起動するには、以下を実行してください。Ctrl + C を押すと終了します。

cd /path/to/log-archiver
bin/ircbot

-c（--config）オプションで、使用する設定を指定することができます。その場合、-c に続けて設定 ID を書きます。

cd /path/to/log-archiver
bin/ircbot -c test # /path/to/log-archiver/config/test.yaml を使用する場合

Web アプリケーションの起動

記録されたログを閲覧するための Web アプリケーションは、Rails アプリケーションとして実装されています。

単体で起動させることもできますが、Apache や nginx からのリバースプロキシ設定を行なうことをお勧めします。

バックグラウンドジョブの起動

バックグラウンドジョブを実行するためのアプリケーションを起動します。

バックグラウンドジョブを使用しないのであれば、省略可能です。

開発者の方へ

テストを実行する際は「テストの実行手順」を参照してください。

素材

閲覧システムのホームページの背景に「The Die」（Zane Mattingly氏制作；CC BY-NC-SA 2.0）を利用しています。

連絡先

ご意見・ご要望・バグ報告等は、irc.cre.jp 系 IRC サーバ群の IRC チャンネル「#cre」や、GitHub リポジトリ上の「Issues」・「Pull Requests」にて承っております。お気軽にお寄せください。

ライセンス

• MIT License（日本語）
• 閲覧システムホームページの背景用として加工された画像（public/images/the-die-1024-dark.jpg）については、上記ライセンスを継承したCC BY-NC-SA 4.0とします。

制作

© 2017-2019 クリエイターズネットワーク技術部

• 鯉（@koi-chan）
• ocha（@ochaochaocha3）
• らぁ（@raa0121）