BoltzEngine 3.x マイグレーションガイド

BoltzEngine 3.x 未満から 3.x 以降へのアップデート方法についてご説明します。

BoltzEngine の再インストール (Linux で RPM からインストールされた場合)

BoltzEngine はこれまでご利用者様ごとにビルドしてご提供しておりましたが、プロダクトキー及びライセンスサーバによる認証に変更となりました。

このため RPM でインストールされた方についてはパッケージ名が変更となりますので、一度アンインストールした上で新しい BoltzEngine を導入していただく必要があります。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


$ # RHEL7系での操作例
$ sudo systemctl stop boltz-master
$ sudo systemctl stop boltz-slave
$ sudo yum list | grep boltz            # => インストールされているパッケージを確認
$ sudo yum remove boltz-(ご利用者名)
$ sudo rpm -ivh boltz-engine-(バージョン).rpm
$ # ここで次の「プロダクトキーの設定」を実施してください)
$ sudo systemctl start boltz-auth-server
$ sudo systemctl start boltz-slave
$ sudo systemctl start boltz-master

BoltzMessenger をご利用の場合は DB マイグレーションも必要になります。以下を参考にしてください。

参考：Linux 版 BoltzEngine をアップデートするには

プロダクトキーの設定

BoltzEngine 3.x 以降の起動には、これまでのアンロックキーに代わりましてプロダクトキーが必要です。ご利用者様専用サイトからプロダクトキーをダウンロードできます。

BoltzEngine 3.2.x 以降、プロダクトキーファイルを元にライセンスサーバーとマスターノードが通信を行います。ファイルが存在しない場合動作しませんので、ご注意ください。

参考：ライセンスサーバー

Linux での設定方法

ダウンロードした license ファイルを適切な場所 (例: /etc/boltz/license などに設置する)
/etc/sysconfig/boltz/master(RHEL7系)もしくは/etc/init/boltz-master.conf を開き、license の行に設置した場所を指定する
BoltzEngine Master サービスを再起動する

Windows での設定方法

インストーラーでファイルを指定することができます。

boltz auth-server の追加

認証管理サービスとしてauth-serverという新しいプロセスが増えました。スレーブサービスから接続し、同一の時間内で生成されるキーを管理します。APNs HTTP/2 JWT 認証をお使いになる場合は、インターネット側のIPアドレスが同一のスレーブを同一のauth-serverにすべて収容する必要があります。接続先の設定は以下のパスにあります。

/etc/sysconfig/boltz/auth-server (RHEL7系)
/etc/init/boltz-auth-server.conf (RHEL6系)

BoltzMessenger の設定変更 (APNs の HTTP/2 への切替)

BoltzMessenger で APNs HTTP/2 トークン認証を使用するには、config.yml の設定変更が必要です。

旧書式

# legacy APNs
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

新書式

APNs HTTP/2 + 証明書方式

# APNs HTTP/2 + certificated-based auth
apns:
  key: /etc/boltz-messenger/key.pem
  cert: /etc/boltz-messenger/cert.pem
  gateway: https://api.push.apple.com/
  topic: com.example.app.id

項目	設定内容
key	APNs 接続用の秘密鍵ファイルパス (パスワードなしのpemファイル)
cert	APNs 接続用の証明書ファイルパス
gateway	APNs のアドレス。デバッグビルドの場合は SANDBOX 環境( https://api.sandbox.push.apple.com/ )を指定する必要がある
topic	APNs 送信先トピック (アプリの Bundle Identifier)

接続用の秘密鍵/証明書は「アプリへのプッシュ通知の実装」ページにガイド記事「iOSでのプッシュ通知の準備(HTTP/2・証明書認証での接続の場合)」をご用意していますので、こちらを参考に発行してください。

APNs HTTP/2 + トークン方式

# APNs HTTP/2 + token-based auth
apns:
  issuer: xxx
  keyId: xxx
  privateKey: /etc/boltz-messenger/key.p8
  gateway: https://api.push.apple.com/
  topic: com.example.app.id

項目	設定内容
issuer	APNs JWTのIssuer (Develper ProgramのTeam ID)
keyId	APNs JWTのキーID
privateKey	p8ファイルのパス
gateway	APNs のアドレス。デバッグビルドの場合は SANDBOX 環境( https://api.sandbox.push.apple.com/ )を指定する必要がある
topic	APNs 送信先トピック (アプリの Bundle Identifier)

認証キーは「アプリへのプッシュ通知の実装」ページにガイド記事「iOSでのプッシュ通知の準備(HTTP/2・トークン認証での接続の場合)」をご用意していますので、こちらを参考に署名キーを発行してください。

BoltzMessenger の設定変更 (FCM の HTTP v1 への切替)

BoltzMessenger で FCM HTTP v1 方式の通信を使用するには、config.yml の設定変更が必要です。

また、GCM は 2019 年 4 月 11 日でサービスが終了しているため、FCM を利用していただかなければなりません。

旧書式

# FCM-Legacy HTTP
fcm:
  key: xxx
  url: https://fcm.googleapis.com/fcm/send

# FCM-XMPP
fcm:
  key: xxx
  senderId: xxx
  url: fcm-xmpp.googleapis.com:5235

新書式

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

項目	設定内容
serviceAccount	service-account.json へのパス
url	初期値のままで問題ありません

なお、ervice-account.json は「アプリへのプッシュ通知の実装」ページにガイド記事「Android でのプッシュ通知の準備」をご用意していますので、こちらを参考に取得してください。

目次