チュートリアル¶

概要¶

このチュートリアルでは、Sora に組み込まれている開発者ツールを動かして、ひととおり使ってみるところまでを説明します。

チュートリアルの注意点¶

• このチュートリアルでは、リバースプロキシとしての nginx や HTTPS の知識を必要とします
• Sora は TCP と UDP の両方を利用します
  • TCP はデフォルトであれば 3000 番と 5000 番を利用します
  • UDP はデフォルトであればエフェメラルポートの範囲を利用します
• Sora の開発者ツールは Sora に組み込まれているものを利用して下さい
• Sora の開発者ツールは HTTPS 非対応のため、nginx をリバースプロキシとして利用して、TLS 終端を行ってから Sora に繋ぐ必要があります
• Sora のシグナリングは WebSocket over TLS 非対応のため、nginx をリバースプロキシとして利用して、 TLS 終端を行い Sora のシグナリングへ繋ぐ必要があります

Sora の展開¶

tar.gz で圧縮されていますので、展開して下さい。

$ tar xfz sora-<version>-<os>.tar.gz

設定ファイル¶

設定ファイルは Sora を展開した sora-<version>/etc/sora.conf にあります。まずは開発者ツールを動作させるまでの最低限の設定を行います。

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

1. ライセンスファイルの指定
   • ライセンスファイルを etc/ において、cp コマンドを利用して license.json に変更して下さい。
2. 開発者ツールの有効化
   • Sora には簡単に検証してもらうための開発者ツールを組み込んでいます。 devtools 項目の # を削除して設定を有効にし、 加えて、設定値に true を指定して Sora に組み込まれている開発者ツールを有効化してください。

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

## 開発者ツールを有効にするかどうかを指定してください
## オプションでデフォルト false です
devtools = true

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

起動¶

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

$ sora-<version>/bin/sora daemon

$ sora-<version>/bin/sora stop

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

HTTPS (WebSocket over TLS を含む) の適用は必ず行ってください。HTTPS への接続以外はサポート対象外となります

ブラウザで WebRTC の機能の一つである getUserMedia を利用する場合は HTTPS が必須となります。 ただし、Sora 自体は HTTPS 非対応のため、Sora の前段にリバースプロキシとして nginx を設置して TLS 終端を行ってください。

nginx の location ディレクティブの設定については nginx を参考にして設定をお願いします。

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

リバースプロキシとしての nginx の役割:

// 開発者ツールの静的ファイルの場合
クライアント -> <HTTPS:443> -> nginx -> <HTTP:5000> -> Sora

// シグナリングの場合
クライアント -> <WebSocket over TLS:443> -> nginx -> <WebSocket:5000> -> Sora

開発者ツールを利用してみる¶

Sora に組み込まれている開発者ツールの使い方を説明します。 開発者ツールでは Sora の持っている一通りの配信機能を試すことができます。

ブラウザで https://<設定したドメイン>/ にアクセスして以下のような画面が表示されれば成功です。

動作確認¶

ビデオ会議システムなどで利用されるような双方向での配信機能です。 受信だけ、送信だけでの利用も可能です。

マルチストリーム送受信 を開き connect を押して、 その後、別のブラウザやタブで同じ URL を開いて、 connect を押して下さい。

追加でタブを開いて connect していけば参加者を増やせます。

開発ツールでは気軽にいろいろな設定を試せるようになっています。触ってみてください。

次のステップ¶

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

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

また、 Sora はいろいろな機能を持っていますので、一通りドキュメントをご確認下さい。

トラブルシューティング¶

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

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

## 開発者ツールを有効にするかどうかを指定してください
## オプションでデフォルト false です
devtools = true