インストール手順 (Linux RHEL7系)

RedHat Enterprise Linux 7 系でのインストール手順をご説明します。

概要

Boltz パッケージについて

Boltz パッケージは、送信エンジン BoltzEngine と、 BoltzEngineを利用したリファレンス実装 BoltzMessenger の2つが含まれます。
BoltzEngine 単体ではメッセージ配信しか行いませんので、メッセージの内容やデバイスの管理はアプリごとに作成する必要があります。

BoltzMessenger は BoltzEngine を使ったサービスのリファレンス実装です。 BoltzMessenger には、管理画面、iOS アプリ、Android アプリ、API が含まれます。
BoltzMessenger のソースコードはお渡ししますので、そのままでも使っていただけますし、カスタマイズしていただいても構いません。(カスタマイズされた部分はサポート対象外となります)

このドキュメントについて

この文書では、Linux 版の BoltzMessenger を動作させるまでの手順を解説します。
インストールする RPM パッケージは6つあります。

上記のパッケージは、すべて1台のサーバに同居することも可能ですし、すべて別のサーバにインストールすることもできます。 このドキュメントでは、 BoltzMessenger を1台のサーバにインストールを行い、分散させる場合の設定項目を補足として記載します。
BoltzEngine Tools については『BoltzEngine Toolsマニュアル』を参照ください。

ドキュメントの表記

本ドキュメントでは、お客様に実施していただくコマンドをプロンプト付きで表記します。

// 一般ユーザ権限でコマンド実行する場合
$ command

// スーパーユーザ権限でコマンドを実行する場合(sudoでも可)
# command

また、各自の環境により読み替えが必要な場所は (xxx) と表記します。

boltz-engine-(バージョン).el7.x86_64.rpm

システム条件

BoltzMessenger をインストールするには、以下の条件を満たしている必要があります。

• RedHat Enterprise Linux 7系 Linux(CentOS 7等) または RedHat Enteprise Linux 6系(CentOS 6等)
• 100Mbps 以上のネットワーク(インターネットに対して高速な接続ができるネットワークを推奨します)
• (iOSへHTTP/2でプッシュを送信する場合) api.push.apple.com の 443 ポートに対して通信可能であること
• (iOSへバイナリインターフェイスでプッシュを送信する場合) gateway.push.apple.com の 2195 ポートに対して通信可能であること
• (iOSへバイナリインターフェイスでプッシュを送信する場合) feedback.push.apple.com の 2196 ポートに対して通信可能であること
• (Androidへプッシュを送信する場合) fcm.googleapis.com の 443 ポートに対して通信可能であること
• (FireOSへプッシュを送信する場合) api.amazon.com の 443 ポートに対して通信可能であること
• アプリからアクセスするためのポートを解放可能であること(デフォルトでは TCP/13070)
• 管理画面へアクセスするためのポートを解放可能であること(TCP/80 または TCP/443)

推奨バージョン

BoltzMessenger が依存するミドルウェアは下記のバージョンを推奨しますが、BoltzMessenger Web を除いて、ディストリビューション付属のバージョンでも動作します。

• Apache 2.4
• PHP 5.6
• MySQL 5.6

必須パッケージ

各パッケージをインストールするために必要な依存関係は以下の通りです。

BoltzEngine に必要なパッケージ

• なし

BoltzMessenger Gateway に必要なパッケージ

• rsyslog

BoltzMessenger Admin に必要なパッケージ

• httpd
• php
• php-mysql
• php-mbstring
• php-mcrypt

BoltzMessenger Web に必要なパッケージ

標準リポジトリ外から PHP 5.6 を入手する必要があります。Software Collections(SCL) から入手する方法を以下で紹介しております。

• httpd
• php
• php-mysql
• php-mbstring
• php-mcrypt
• php-intl

BoltzMessenger policy module に必要なパッケージ

• policycoreutils
• libselinux-utils

依存するサービス

BoltzMessenger をご利用になる場合、サーバ内または外部にMySQLサービスをご用意ください。

MySQLサービス(MariaDB)をインストールされる場合は以下のコマンドで行えます。

# yum install mariadb-server
# systemctl enable mariadb.service
# systemctl start mariadb.service

ファイル構造

BoltzEngine と BoltzMessenger が利用するディレクトリは以下の通りです。

インストール

BoltzEngine のインストール

BoltzEngine のインストールを行います。

# rpm -ivh boltz-engine-(バージョン).el7.x86_64.rpm

プロダクトキーの設定

製品版・体験版のBoltzEngineをお使いの場合、プロダクトキーファイルを設定する必要があります。このファイルはご契約者様専用サイトでダウンロードするか、体験版お渡し時にフェンリルの担当より一緒にお渡しします。このファイルを任意の場所に設置していただき (例えば、/etc/sysconfig/boltz/license等)、/etc/sysconfig/boltz/master ファイルのlicense=行に記載します。

1listen_addr=:13010
2grpc_listen_addr=:13009
3slaves=:13007
4log_output='file:///var/log/boltz-master.log'
5license='/etc/sysconfig/boltz/license'

プロダクトキーファイルがない場合でもBoltzEngineは起動しますが、性能に大幅な制限がかかります。

BoltzEngine の起動

インストールを行うと、systemd 管理下のサービスが2つ実行可能になります。

この2つのサービスは別のサーバで実行しても問題ありませんが、ここでは1台で両方実行します。

// サーバ起動時に自動起動させる
# systemctl enable boltz-auth-server.service
# systemctl enable boltz-slave.service
# systemctl enable boltz-master.service

// サービスを実行する
# systemctl start boltz-auth-server.service
# systemctl start boltz-slave.service
# systemctl start boltz-master.service

boltz-auth-server の設定変更

boltz-auth-server の設定を変更するには、/etc/sysconfig/boltz/auth-server ファイルを編集します。

boltz-slave.service の設定変更

boltz-slave.service の設定を変更するには、/etc/sysconfig/boltz/slave ファイルを編集します。

ログ出力先は以下の形式となっており、利用可能パラメータは(scheme)により変わります。

(scheme)://(host)/(path)?(facility=x)&(tag=x)

(facility)は、“sys”, “app”, “service”, “security"の4種類です。
それぞれ、syslogのkern, user, daemon, authprivに対応します。
(tag)は任意のものを指定していただけます。

boltz-master.service の設定変更

boltz-master.service の設定を変更するには、/etc/sysconfig/boltz/master ファイルを編集します。

log_output については、boltz-slave.serviceの設定変更を参照ください。

boltz-slave.service を分散する

boltz-master.service は複数の boltz-slave.service を束ねることができます。
host1 と host2 の 2 台を使って構成する場合、host1 に master と slave 及び auth-server を、host2 には slave だけを実行させるように構成します。

host1:
# rpm -ivh boltz-engine-(お客様名)-(バージョン).el7.x86_64.rpm
# systemctl enable boltz-auth-server.service
# systemctl enable boltz-slave.service
# systemctl enable boltz-master.service
# systemctl start boltz-auth-server.service
# systemctl start boltz-slave.service
# systemctl start boltz-master.service

host2:
# rpm -ivh boltz-engine-(お客様名)-(バージョン).el7.x86_64.rpm
# systemctl enable boltz-slave.service
# systemctl start boltz-slave.service

host1 で稼働する boltz-master.service の設定ファイルは以下のようになります。

listen_addr=:13010
slaves=host1:13007,host2:13007

host2 で稼働する boltz-slave.override ファイルは以下のようになります。

auth_addr=host1:13008

BoltzMessenger Gateway は host1:13010 へアクセスするように設定すると、boltz-master.service が両方の slave を使って送信を分散させます。

同一のAPNs HTTP/2認証キーを用いて同一のIPアドレスからインターネットに接続するスレーブは、同一のauth-serverを参照するように設定する必要があります。

BoltzMessenger Gateway のインストール

依存関係の解決

BoltzMessenger Gateway は他のパッケージに依存しています。
rsyslog は CentOS 7 に標準でインストールされていますが、もし無い場合はインストールしてください。

# yum install rsyslog

BoltzMessenger Gateway パッケージのインストール

依存パッケージを解決できたら、BoltzMessenger Gateway パッケージをインストールします。

# rpm -ivh boltz-messenger-gateway-(バージョン).el7.x86_64.rpm

BoltzMessenger Gateway パッケージをインストールすると、/etc/boltz-messenger/config.yml に設定ファイルが配置されます。BoltzMessengerの各コンポーネントを別のサーバーへ設置する場合、BoltzMessenger Gateway をインストールしないサーバーには手動でこのファイルを作成してください。

次に、DB のテーブル作成など、初期設定を書き込みます。
boltz-messenger-init は BoltzMessenger を動作させるためのテーブル初期化を行い、設定サンプルを出力するコマンドです。
u オプションは DB 接続ユーザ名、p はパスワード、h はホスト名を指定します。

// データベースやテーブルを作成するため、権限を持ったユーザで行うこと
# boltz-messenger-init -u root -p password -h host

boltz-messenger-init コマンドが正常に終わったら、最後に config.yml のサンプルが出力されます。
以下2項目を後の設定で使いますので、控えておいてください。

• admin
  • salt
  • cipherSeed
• web
  • salt

最初のインストール時には、出力をそのまま設定ファイルに書き込んでも問題ありません。

// 上書きするため初回のみのご利用をお勧めします
# boltz-messenger-init -u root -p password -h host >/etc/boltz-messenger/config.yml

BoltzMessenger 用ユーザを作成

権限を絞り込んだ DB 接続ユーザ boltz を利用したい場合、以下のように作成します。

$ mysql -u root -p
Enter password:
mysql> grant all privileges on boltz.* to boltz@localhost identified by 'passpass'; // passpassは実際のパスワードで置き換えてください

作成したユーザとパスワードを config.yml に反映します。

// 設定ファイルの以下を変更する
// db:
//  user: user
//  password: passpass
# vi /etc/boltz-messenger/config.yml

/etc/boltz-messenger/config.yml の確認

config.yml は BoltzMessenger で共通して読み込む設定ファイルです。以下のような構造になっています。

engine:
  address: localhost:13009
  protocol: grpc

# apns1
#apns:
#  key: /etc/boltz-messenger/key.pem
#  cert: /etc/boltz-messenger/cert.pem
#  gateway: gateway.push.apple.com:2195
#  feedback: feedback.push.apple.com:2196

# apns2
apns:
  gateway: https://api.push.apple.com/
  issuer: XXXXXXXXXX
  keyId: XXXXXXXXXX
  privateKey: /etc/boltz-messenger/AuthKey.p8
  topic: com.fenrir-inc.boltzmessenger

# http v1
fcm:
  url: https://fcm.googleapis.com/v1/
  serviceAccount: service-account.json

# legacy
#fcm:
#  url: https://fcm.googleapis.com/fcm/send
#  key: xxx
#  senderId: xxx

adm:
  tokenUrl: https://api.amazon.com/auth/o2/token
  originUrl: https://api.amazon.com
  clientId: xxx
  clientSecret: xxx

webpush:
  privateKey: (private key string encoded by BASE64URL withuout padding)
  publicKey: (public key string encoded by BASE64URL withuout padding)
  skipVerify: false

db:
  driver: mysql
  user: root
  password: boltz
  address: localhost:3306
  name: boltz

admin:
  salt: xxxxxx
  cipherSeed: xxxxxxx
  tempDir: /var/tmp/boltz-messenger
  displayTimezone: Asia/Tokyo
  triggerUrl: http://localhost:13070/requests

web:
  salt: xxxxxxx
  tempDir: /var/tmp/boltz-messenger-web
  displayTimezone: Asia/Tokyo

それぞれの設定における意味を次にまとめます。

※1:boltz-master自身には現在 TLS をサポートしていませんので、環境に応じてロードバランサ等をご用意ください。
※2:boltz-messenger-gatewayにはBoltzMessenger Webが用意しているアプリ向けのAPIが実装されており、frontもしくはbothを指定することで起動します。この機能は後方互換性のために残されています。新規の利用はお控えください。
※3:https://もしくはhttp://が指定されるとHTTP/2モードで送信します。

BoltzMessenger で APNs (iOS) へ通知を行う場合

iOS へPush通知を行う場合、config.yml の apns キーを設定します。

HTTP/2で送信する場合はprivateKeyに指定したパスにp8ファイルを設置し、issuer keyId topicを指定してください。

バイナリインターフェイスで送信する場合は、正しい証明書を apns.key, apns.cert で設定したパスへ配置してください。

BoltzMessenger で FCM (Android) へ通知を行う場合

FCMへの通知は、fcm.urlの値がhttps://またはhttp://で開始する場合、HTTPプロトコルでの通知を行います。
上記以外の場合は、XMPPプロトコルを使った通知を行います。

HTTP v1 APIプロトコルを使われる場合は fcm.serviceAccount が必須です。 それ以外の場合は fcm.key と fcm.senderId を使いますが、Legacy HTTPプロトコルを使う場合は fcm.senderId は任意です。

※後方互換性確保のため fcm キーがない場合、gcm キーも探します。

BoltzMessenger で ADM (FireOS) へ通知を行う場合

ADMへPush通知を行う場合、config.yml の adm キーを設定し、clientId と clientSecret の2つを設定してください。
それぞれの値は Amazon Developer Console のアプリケーション情報から取得できます。

BoltzMessenger で WebPush (Chrome/Firefox) へ通知を行う場合

webpushに使用するVAPID用の鍵ペアはOpenSSLを使い、下記の要領で生成します。(boltz-messenger-init コマンドでも生成します)

$ openssl ecparam -name prime256v1 -genkey -noout -out vapid_private.pem
$ openssl ec -in vapid_private.pem -pubout -out vapid_public.pem
$ openssl ec -in vapid_private.pem -pubout -outform DER|tail -c 65|base64|tr -d '=' |tr '/+' '_-' > public_key.txt
$ openssl ec -in vapid_private.pem -outform DER|tail -c +8|head -c 32|base64|tr -d '=' |tr '/+' '_-' > private_key.txt

生成された public_key.txt および private_key.txt の内容を config.yml に記載してください。また、生成された 4 つのファイルは大切に保管してください。

BoltzMessenger で特定のプラットフォームにのみ配信する場合

apns、fcm、adm、webpush のキーを削除すると、削除したキーのサービスが無効になります。
BoltzMessenger のデータベースに端末が登録されても、無効化したプラットフォームへの通知は実施されず、管理画面にも表示されません。

webpushキーを削除すると、BoltzMessenger Web のウェブアプリケーションは無効になりますが、フロントエンドAPIはこの影響を受けません。

BoltzMessenger で速度制限を行う場合

BoltzMessenger は engine.protocol を grpc に設定した場合に、 1秒あたりの通知速度制限をサポートしています。
有効にするためには、 engine.address と engine.protocol の値を変更します。

engine:
  # boltz-master.serviceのgrpc_listen_addr値を設定
  address: localhost:13009
  # boltz-master.serviceとの通信にgRPCプロトコルを使う
  protocol: grpc
  # ロードバランサ等でHTTPSをサポートする場合はtrue
  secure: false

設定を反映するため、boltz-messenger-gateway.service を再起動してください。

# systemctl restart boltz-messenger-gateway.service

起動設定

// サーバ起動時に自動起動させる
# systemctl enable boltz-messenger-gateway.service

// サービスを実行する
# systemctl start boltz-messenger-gateway.service

boltz-messenger-gateway.service の設定変更

boltz-messenger-gateway.service の設定変更は、/etc/sysconfig/boltz/messenger-gateway にあります。

ポートの解放

必要なら BoltzMessenger Gateway がアプリへ提供する API のポートを開けます。

# firewall-cmd --zone=public --add-service=boltz-messenger-gateway --permanent

SELinux 環境下での BoltzMessenger の使用

SELinux を使用しているサーバーに、 BoltzMessenger Admin と BoltzMessenrger Gateway を同居させる場合、SELinux へのポリシー追加が必要となります。

# rpm –ivh boltz-messenger-selinux-(バージョン).el7.noarch.rpm

また、ポート13070以外で動作させる場合は、合わせて以下のコマンドで SELinux にポートを認識させてください。

# semanage port -a -t boltz_messenger_gateway_port_t -p tcp (ポート番号)

設定後、 BoltzMessenger Admin の画面が表示されない場合は以下の点をご確認ください。

• config.yml のラベルが etc_t になっていない場合は、chcon コマンドで修正してください。

$ ls -lZ /etc/boltz-messenger/config.yml
# chcon -t etc_t /etc/boltz-messenger/config.yml

• RHEL6/CentOS6 系で SELinux が Disabled の状態から、運用後に Enforcing に変えた場合

/var/tmp/boltz- messenger 以下のファイルのラベルを
http_sys_rw_content_t に変更する必要があります。

# chcon -R -t http_sys_rw_content_t /var/tmp/boltz-messenger

Software Collection を用いた Apache HTTP Server と PHP のセットアップ

BoltzMessenger Web をご利用の場合、PHP 5.6 のインストールが必要となります。CentOS 標準の PHP はバージョンが古いため別途 PHP 5.6 を入手していただく必要があります。BoltzMessenger Admin は CentOS 標準の PHP 5.3 でも動作しますが、同様に PHP 5.6 をお使いになることを強く推奨します。

CentOS 向けの PHP 5.6 を提供しているリポジトリはいくつかありますが、CentOS 公式の Software Collections(SCL: https://www.softwarecollections.org/) を用いた BoltzMessenger Admin および Web の依存モジュールインストールの方法をご説明します。

SCL を利用するには、以下のコマンドでリポジトリ定義をインストールします。(SCL から取得されるパッケージの中に EPEL リポジトリ内のパッケージに依存しているものがあるため、合わせてインストールが必要となります。)

# yum install centos-release-scl epel-release

インストールが完了すると、yum のパッケージリポジトリとして SCL (centos-sclo-rh) が追加されます。

BoltzMessenger Admin および Web で必要となるパッケージをインストールします。

# yum install httpd24 httpd24-mod_ssl rh-php56 rh-php56-php rh-php56-php-mysql rh-php56-php-mbstring rh-php56-php-mcrypt rh-php56-php-intl

SCL の Apache HTTP Server を有効にし、起動します。なお、設定ファイルは /opt/rh/httpd24/root/etc/httpd にインストールされます。

# systemctl start httpd24-httpd.service

BoltzMessenger Admin のインストール

依存関係の解決

BoltzMessenger Web は他のパッケージに依存しています。「Software Collection を用いた Apache HTTP Server と PHP のセットアップ」を参照して SCL から PHP 5.6 をセットアップしてください。

異なるリポジトリからインストールする場合は、「必須パッケージ」の項を確認の上、対応するパッケージをインストールしてください。

# yum install httpd php php-mysql php-mbstring php-mcrypt

BoltzMessenger Admin パッケージのインストール

依存パッケージを解決できたら、BoltzMessenger Admin パッケージをインストールします。

# rpm -ivh boltz-messenger-admin-(バージョン).el7.noarch.rpm

BoltzMessenger Admin パッケージは /etc/httpd/conf.d へ BoltzMessenger Admin 用の設定を追加します。SCL を使用している場合は、SCL の httpd24 の設定ディレクトリにコピーする必要があります。

# cp /etc/httpd/conf.d/boltz-messenger-admin.conf /opt/rh/httpd24/root/etc/httpd/conf.d/boltz-messenger-admin.conf

httpd に設定を読ませるため再起動を行います。

# systemctl restart httpd.service (SCL不使用の場合)
# systemctl restart httpd24-httpd.service (SCLの場合)

BoltzMessenger Admin パッケージをインストールしたサーバの URL にアクセスすれば管理画面が表示されます。
(localhost は適切に読み替えてください)

• http://localhost/boltz-messenger/

firewall ポート解放(参考)

BoltzMessenger 管理サイトへアクセスする config を参考程度に記載します。
環境にあわせて修正した上でお使いください。

# cat /etc/firewalld/services/boltz-messenger-admin.xml
<?xml version="1.0" encoding="utf-8"?>
<service>
  <short>boltz-messenger-admin</short>
  <description>boltz messenger administration site</description>
  <port port="80" protocol="tcp"/>
</service>
# firewall-cmd --reload
# firewall-cmd --zone=public --add-service=boltz-messenger-admin --permanent // お好みで

BoltzMessenger Web のインストール

依存関係の解決

BoltzMessenger Web は他のパッケージに依存しています。「Software Collection を用いた Apache HTTP Server と PHP のセットアップ」を参照して SCL から PHP 5.6 をセットアップしてください。

異なるリポジトリからインストールする場合は、「必須パッケージ」の項を確認の上、対応するパッケージをインストールしてください。

# yum install httpd php php-mysql php-mbstring php-mcrypt php-intl

BoltzMessenger Web パッケージのインストール

依存パッケージを解決できたら、BoltzMessenger Web パッケージをインストールします。

# rpm -ivh boltz-messenger-web-(バージョン).el7.noarch.rpm

BoltzMessenger Web パッケージは /etc/httpd/conf.d へ BoltzMessenger Web 用の設定を追加します。SCL を使用している場合は、SCL の httpd24 の設定ディレクトリにコピーする必要があります。

# cp /etc/httpd/conf.d/boltz-messenger-web.conf /opt/rh/httpd24/root/etc/httpd/conf.d/boltz-messenger-web.conf

httpd に設定を読ませるため再起動を行います。

# systemctl restart httpd.service (SCL不使用の場合)
# systemctl restart httpd24-httpd.service (SCLの場合)

ウェブプッシュ機能を使用するためには

ウェブプッシュ機能を使用するためには追加で以下の設定が必要です。

• /etc/boltz-messenger/config.yml に webpush の設定が必要です。「/etc/boltz-messenger/config.yml の確認」に記載のある、VAPID の公開鍵・秘密鍵を設定してください。
• https で BoltzMessenger Web にアクセスできるように設定する必要があります。httpd やリバースプロキシの設定などで https でアクセスできるように構成してください。

上記の設定を加えた上で、BoltzMessenger Web パッケージをインストールしたサーバの URL にアクセスすれば BoltzMessenger フロントエンドウェブアプリケーションが表示されます。
(localhost は適切に読み替えてください)

• https://localhost/bm/

firewall ポート解放(参考)

BoltzMessenger フロントエンドウェブアプリケーションへアクセスする config を参考程度に記載します。
環境にあわせて修正した上でお使いください。

# cat /etc/firewalld/services/boltz-messenger-admin.xml
<?xml version="1.0" encoding="utf-8"?>
<service>
  <short>boltz-messenger-web</short>
  <description>boltz messenger frontend</description>
  <port port="80" protocol="tcp"/>
</service>
# firewall-cmd --reload
# firewall-cmd --zone=public --add-service=boltz-messenger-web --permanent // お好みで

アンインストール

BoltzEngineのアンインストール

# systemctl stop boltz-master.service
# systemctl stop boltz-slave.service
# systemctl disable boltz-master.service
# systemctl disable boltz-slave.service
# rpm -e boltz-engine-(お客様名)

BoltzMessenger Gatewayのアンインストール

# systemctl stop boltz-messenger-gateway.service
# systemctl disable boltz-messenger-gateway.service
# rpm -e boltz-messenger-gateway
# rm /etc/boltz-messenger/config.yml.rpmsave

BoltzMessenger Adminのアンインストール

# rpm -e boltz-messenger-admin

BoltzMessenger Webのアンインストール

# rpm -e boltz-messenger-web