install.md

インストール

依存する他のプログラム(データベースなど)のインストール

log-archiver は、単独のサーバとして起動します。しかし、直接インターネットからアクセス出来るようにはしないでください(セキュリティ的・パフォーマンス的な問題があります)。 nginx や Apache などのウェブサーバをリバースプロキシとして用意することを強く勧めます。

Rails が、JavaScript ランタイムを必要とするエラーを出力することがあります。その場合は、nodejs パッケージをシステムにインストールするか、Gemfile に therubyracer を追加してください。

log-archiver は、チャットログの保存先として、リレーショナルデータベース管理システムとして MySQL もしくは MariaDB と、全文検索エンジン Groonga 、RDBMS プラグインとして Groonga を使用するための Mroonga が必要です。 これらのインストールは、Mroonga 公式サイト を参照してください。

バックグラウンドジョブを実行する際に、ジョブ管理のため Redis データベースを必要とします。

log-archiver は Ruby と JavaScript で書かれています。 対応しているバージョンの Ruby 実行環境をインストールし、Ruby のライブラリバージョン管理システム Bundler と JavaScript のライブラリバージョン管理システム Yarn を使えるようにしてください。

log-archiver はバージョン管理システム git で配信されています。git を使ってプログラムをダウンロードする場合は、これもインストールしてください。

log-archiver のダウンロード

git から直接ダウンロードするには、次のコマンドを実行してください。

git clone https://github.com/cre-ne-jp/log-archiver.git
cd log-archiver

次に、必要なライブラリをダウンロードします。

bundle install --deployment --path vendor/bundle
corepack enable
yarn install

アセットとプリコンパイル

アセット(JavaScript/CSS)のプリコンパイルと、依存する JavaScript ライブラリのインストール (yarn install) を実施します。

RAILS_ENV=production bin/rails assets:precompile
NODE_ENV=production yarn webpack

データベースの設定

チャットログに含まれる絵文字等を正しく扱えるようにするため、MySQL/MariaDB の設定を変更する必要があります。 /etc/my.cnf や /etc/my.cnf.d/server など、ディストリビューションによって書き換えるファイルが違います。 [mysqld] で始まる行があるファイルを開き、その行の直後に以下の設定を追記してください。 この設定変更は、MySQL/MariaDB を使う他のプログラムにも影響を与えることがあります。

character-set-server = utf8mb4
collation-server = utf8mb4_general_ci
innodb_file_per_table = 1
innodb_file_format = Barracuda
innodb_large_prefix

ファイルを書き換えたら、MySQL/MariaDB を再起動してください。

MySQL もしくは MariaDB にログインし、ユーザーとデータベースを作成します。 データベースアクセスのために作成するユーザーのパスワードは予め作成しておいてください。以下のコマンド例中の は、作成したパスワードを入力します。

mysql -uroot -p
CREATE DATABASE log_archiver_production;
GRANT ALL PRIVILEGES ON log_archiver_production.* to log_archiver@localhost by '<password>';
flush privileges;
exit;

次に、設定ファイルを用意します。

cp config/database.yml.example config/database.yml
vi config/database.yml

一番下の production: から始まる行が、書き換えるデータベース設定です。 database:、username: の 2 項目を、お使いの環境に合わせて書き換えてください。 パスワードは後ほど設定します。

最後に、テーブルを作成します。

bin/rails db:migrate RAILS_ENV=production
bin/rails db:seed RAILS_ENV=production

Puma の設定

log-archiver のウェブサーバである Puma の設定です。 まず、設定ファイルを用意します。

cp config/puma.rb.example config/puma.rb

必要があれば書き換えてください。

IRC ボットの設定

実際に IRC サーバに接続し、チャットログを収集するボットの設定です。 まず、設定ファイルを用意します。

cp config/ircbot.yml.example config/ircbot.yml
vi config/ircbot.yml

先頭行の development を production に書き換えます。 末尾にある production: と書かれた行を削除します。

他の各項目について、ご利用の環境に合わせて設定を書き換えてください。 設定項目について詳しくは irc.md をご覧ください。

環境変数の設定

データベースのパスワードや、セッションを安全に保つための鍵などを環境変数として設定します。 次のテンプレートファイルをコピーして使ってください。

cp doc/log-archiver.default .
vi log-archiver.default

systemd への登録

システム起動時、自動的に log-archiver を起動させるための設定です。 systemd に登録します。

まず、ご自身の環境に合わせて設定ファイルを書き換えます。

cp doc/log-archiver_* .
vi log-archiver_puma.service
vi log-archiver_ircbot.service
vi log-archiver_sidekiq.service

Ruby インタプリタや、log-archiver のパスを確認してください。 終わったら、設定ファイルをシステムに登録します。

sudo mv log-archiver_{puma,ircbot,sidekiq}.service /etc/systemd/system/
sudo mv log-archiver.default /etc/default/log-archiver
sudo systemctl daemon-reload

nginx の設定

前述の通り、log-archiver を直接インターネットから接続可能にすることは推奨されません。 ここではリバースプロキシの例として、nginx を例に取ります。

まず、ご自身の環境に合わせて設定ファイルを書き換えます。

cp doc/nginx/log-archiver-ssl .
vi log-archiver-ssl

upstream の server に指定するのが、log-archiver の puma です。 config/puma.rb に指定した値と同じになるように書き換えます。

YOUR_SERVER_FQDN を、log-archiver の URL に書き換えてください。

必要に応じて、listen 行に書かれた default_server を削除してください。

次に、nginx の設定ディレクトリに設定ファイルを移動し、設定ファイルの書式が間違っていないか確認します。

sudo mv log-archiver-ssl /etc/nginx/sites-enabled/
nginx -T

エラーが出なければ問題ありません。設定ファイルが読み込まれていないときには何のエラーも出ませんので注意してください。

動作確認

systemd から起動してみて、エラーが発生しないことを確認してください。 次に、IRC サーバにログインできているか、ウェブサーバにアクセスしてページが表示されるかを確認してください。

問題が無ければ、ウェブインターフェイスからログを収集するチャンネルを作成し、収集を有効にすることで、発言がデータベースに保存されるようになります。