Sora 2020.1 での設定ファイルの変更について

概要

Sora 2020.1 にて設定ファイルの下位互換性を破壊する変更が入りました。

変更の理由

今までの Sora の設定ファイルは設定ファイルが置かれている場所がわかりにくく、 さらには設定ファイルにインターナルな設定が含まれていたため、 残念ながら使いやすいと呼べるものではありませんでした。

Sora 2020.1 では設定ファイルの形式や場所をわかりやすくするため、設定ファイルの形式と設定ファイルのパスの変更を行っています。

変更点

  • 設定ファイルが sora-<version>/releases/<version>/sys.config から sora-<version>/etc/sora.conf に変わります

  • 設定ファイルの記述方式が key = value に変わります

  • コメントの記述方式が % から # に変わります

  • 初期設定では全ての設定がコメントアウトされている状態になります

重要

今後 sora-<version>/releases/<version>/sys.config は一切変更しないようお願いいたします

19.10 までの設定ファイル

設定ファイルの場所

sora-<version>/releases/<version>/sys.config

[
 {sora, [
         %% ライセンスファイルを指定してください
         {license_file, "etc/license.json"},

         %% 認証やイベントのウェブフックの通知に含まれるサーバ識別用のラベルを指定可能です
         %% 指定しない場合は "WebRTC SFU Sora" が送られます
         %% {label, "sora-label"},

         %% サーバで利用する IPv4 アドレスを指定してください
         %% 指定が無い場合は自動で見つけたアドレスを利用します
         %% {ipv4_address, "192.0.2.100"},

         %% ... 省略

         %% WebRTC の接続が確立するまでの許容時間を秒で指定してください
         {connection_created_wait_timeout, 30}
        ]},
 ...
].

2020.1 からの設定ファイル

設定ファイルの場所

sora-<version>/etc/sora.conf

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

## 認証やイベントのウェブフックの通知に含まれるサーバ識別用のラベルを指定可能です
## 指定しない場合は "WebRTC SFU Sora" が送られます
# label = sora-label

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

## ... 省略

## WebRTC の接続が確立するまでの許容時間を秒で指定してください
# connection_created_wait_timeout = 30