チュートリアル

ライブラリのインストール

x86_64

Ubuntu 20.04:

$ tar xvfz sora-<version>-ubuntu20.04.tar.gz

Ubuntu 18.04:

$ tar xvfz sora-<version>-ubuntu18.04.tar.gz

CentOS 8.1:

$ tar xvfz sora-<version>-centos8.1.tar.gz

CentOS 7.8:

$ tar xvfz sora-<version>-centos7.8.tar.gz

設定ファイル

設定ファイルは sora-<version>/sora.conf にあります。 まずは動作させるまでの最低限の設定を行います。

# はコメントになっている部分ですので、設定する項目がコメントになっている場合は # を削除して設定項目を有効にしてください。

  1. ライセンスファイルの指定

    • ライセンスファイルを etc/ において cp コマンドを利用して license.json に変更して下さい。

  2. デモ機能の有効化

    • Sora には簡単に検証してもらうためのデモ機能を用意しています。 demo 項目の # を削除して設定を有効にし、加えて、設定値に true を指定してデモ機能を有効化してください。

## ライセンスファイルを指定してください
## この設定はオプションで、デフォルトは "etc/license.json" です
# license_file = etc/license.json

## デモ機能を有効にするかどうかを指定してください
## オプションでデフォルト false です
demo = true

他の設定はここでは不要です。

起動

設定が終わったらサーバを起動します。

起動:

$ sora-<version>/bin/sora daemon

停止:

$ sora-<version>/bin/sora stop

シグナリングへの HTTPS の適用

HTTPS の適用は必ず行ってください、HTTPS への接続以外はサポート対象外となります

Chrome や Safari で WebRTC を利用する場合 HTTPS が必須となります。 そのため、 Sora の前段に Nginx を置いて HTTPS 化をしてください。

Nginx の設定については Nginx を参考にしてください。

注意

Nginx の設定に関する質問については Sora のサポート範囲外となります。

証明書については Let's Encrypt - Free SSL/TLS Certificates の利用をおすすめします。

注意

Let's Encrypt に関する質問については Sora のサポート範囲外となります。

デモ

ここではドメインを仮に example.com としています。

配信テスト

まずは https://example.com/sendonly.html に接続し、connect してみてください。

その後 https://example.com/recvonly.html に接続し、connect して映像が配信されてきたら成功です。 この recvonly.html を複数のタブで開いてみてください。複数に配信していることが確認してみてください。

タイムアウトが起きてつながらない場合

OS の設定でファイアウォールで UDP の通信ができない場合は接続に失敗します。

Sora が利用する UDP のポートの範囲は通常 32768 から 60999 です。この範囲の通信を許可にしてみてください。

それでもうまく繫がらない場合

サーバの IPv4 アドレスを ipv4_address に指定して、 ipv6false にして見てください。

## ライセンスファイルを指定してください
## この設定はオプションで、デフォルトは "etc/license.json" です
# license_file = etc/license.json

## サーバで利用する IPv4 アドレスを指定してください
## 指定が無い場合は自動で見つけたアドレスを利用します
ipv4_address = 192.0.2.10

## デモ機能を有効にするかどうかを指定してください
## オプションでデフォルト false です
demo = true

注釈

Amazon EC2 インスタンス等のようなパブリック IP アドレスとプライベート IP アドレスが異なる環境では、 ブラウザからアクセス可能な IP アドレス(パブリック IP アドレス)を ipv4_address に設定してください。

よくある問題

  • Sora が利用するポートを他のプロセスが利用していないかを確認してください

    • 他のプロセスが Sora が利用しているポートを利用している事で起動しないということがあります

  • Nginx の設定などを見直してください

    • Nginx の設定をミスしている場合があります

    • Nginx の設定が反映されていなかったなどあります

それでもダメな場合

お問い合わせください。その際にログや状況などをお送りください。

  • Sora のバージョン

  • Sora の設定ファイルである sora.conf

  • log フォルダ以下すべてを tar.gz にて圧縮してお送りください

    • 容量が 1 メガバイトを超える場合は事前にご連絡ください、アップローダーをご提供します

  • 繋がらなかったブラウザを利用している OS とバージョン

  • 繋がらなかったブラウザの種類とバージョン

  • デモ機能を利用した場合のブラウザの console ログ

  • ファイアウォールの設定

  • IPv6 アドレスが有効かどうか

それ以外にも可能な限りの情報をお送りください。

次のステップ

  • sora.confipv4_address にサーバの IP アドレスを指定してください

本番稼働に向けて をお読みください。