セットアップ手順 (さくらのクラウド:スタートアップスクリプト)

BoltzEngine 3.2.x 以降、さくらインターネットのさくらのクラウドにて、スタートアップスクリプトで BoltzEngine がインストールできるようになります。

事前に準備するもの

  • さくらインターネットの契約
    • 契約アカウント を用いて、さくらのクラウドを利用する
  • プッシュ通知を送信するターゲットアプリケーション(以下何れか1つは必要)
    • APNs (iPhone/iPad/Apple Watch)
      • Issuer ID (Develper Program の Team ID)
      • Key ID (p8 ファイル作成時に同時に発行されるID)
      • Topic (アプリの Bundle ID)
      • Private Key (p8 ファイル)
    • FCM (Android Device)
      • service-account.json
    • ADM (Fire Tablet)
      • OAuth2 client ID
      • OAuth2 client secret
    • ウェブブラウザ(ウェブプッシュに対応しているもの)
      • 送信者 (メールアドレス)

構築手順

先ず、さくらのクラウドから [マーケットプレイス] を開き、 [BoltzEngine] を選択します。

[マーケットプレイス] で [BoltzEngine] が選択されていることを確認します。

実際に構築する前に、こちらの説明文に目を通すようにしてください。

※BoltzEngine を使用する場合はドメインと TLS 1.2 以降の環境が必要になります

推奨環境は CPU 2 コア以上、メモリ 4 GB 以上です。 それ以下のスペックでも動作はしますが、リソースが足りなくなる場合がございます。

ディスイクは 10 GB 以上の空き容量が推奨環境となります。 スタートアップスクリプトで環境構築する場合、同時に MySQL がサーバ内にインストールされますので、空き容量にはご注意ください。

BoltzEngine は外部(Apple の APNs や Google の FCM 等)と通信を行いますので、外部と通信が可能な構成にしてください。

サーバの設定を行います。

入力 種別 項目名 設定内容
必須 共通 利用規約 (EULA) に同意して利用する EULA に同意していただく必要がございます
必須 DB 接続ユーザ名 デフォルト値で boltz が入力されていますが、変更していただいてもかまいません
必須 DB パスワード 接続ユーザ のパスワードを設定してください
必須 DB rootパスワード root ユーザのパスワードを設定してください
任意 APNs Issuer ID (Develper Program の Team ID) Develper Program の Team ID を設定してください
任意 APNs Key ID (p8 ファイル作成時に同時に発行されるID) p8 ファイル作成時に同時に発行される ID を設定してください
任意 APNs Topic (アプリの Bundle ID) アプリの Bundle ID(ex. com.example.app.**********)
任意 APNs Private Key (p8 ファイルの内容) p8 ファイルの内容を登録してください
任意 FCM サービスアカウントキーが含まれる JSON ファイルの中身 service-account.json の中身を登録して下さい
任意 ADM OAuth2 client ID ADM の OAuth2 用の Client ID を登録してください(ex.amzn1.application-oa2-client.********************************)
任意 ADM OAuth2 client secret ADM の OAuth2 用の Secret ID を登録してください(ex.01234567489abcdrf01234567489abcdrf01234567489abcdrf01234567489ab)
任意 WebPush 送信者 (subject) mailto:info@example.com 形式でサービス用のメールアドレスを入力して下さい

任意のホスト名を登録してください。 サーバの作成数は 1 で問題ありません。

費用を確認し、[作成] ボタンを押下してください。

注意事項

ドキュメント作成時点でのさくらのクラウドの仕様になりますが、ウェブコンソールからサーバーが起動状態になってもスタートアップスクリプトが完走しているとは限りません。

スタートアップスクリプトが確実に完走していることを確認するには、サーバにログインし、 /root/.sacloud-api/notes/スタートアップスクリプトID.done の存在を確認する必要があります。

参考:2. スタートアップスクリプトの動作 - さくらのクラウド

構成について

SSL

スタートアップスクリプトでセットアップされた直後は、経路が SSL 化されていません。

サーバ内で直接 SSL 化するか、 Enhanced LB で SSL 接続終端処理を施すことを検討してください。

DB

DB は同一サーバ内に MySQL がインストールされ、そちらに全てのデーターが格納されています。

サーバーの外部に DB を用意したい場合は、こちらからデーターの移植後、 /etc/boltz-messenger/config.yaml を直接変更し、接続先などを修正してください。

トラブルシューティング

  1. サーバーが起動したが、BotlzEngine が動作していない
    • スタートアップスクリプトが完走していない可能性があります。実行完了ファイルの存在を確認するか、ログを確認するかしてください。
  2. プッシュ通知が届かない
    • 以下の点を調査してください
      • 共通
        • ネットワークは外部と接続されていますか?
      • APNs
        • Bundle ID は正しいですか?
        • アプリのビルドは本番用ですか? デバッグ用ですか?
          • デバッグ用のビルドの場合、APNs のエンドポイントを変更していただく必要がございます
        • p8 ファイルは正しいものをご利用頂けていますか?
      • FCM
        • 使用している service-account.json は正しいですか?
      • ADM
        • OAuth2 用の設定項目を正しく取得できていますか?
      • WebPush
        • BoltzMessenger Admin / Web は TLS 1.2 以降を利用した接続が出来るようになっていますか?
        • スタートアップスクリプトを実行した後、サーバの SSL 化か Enhanced LB による SSL 接続終端処理を行いましたか?

ご不明な点はありませんか?

機能の詳細、導入のご検討、お見積もり依頼などは、お気軽にお問い合わせください。
担当者から追ってご連絡いたします。

お問い合わせはこちら