はじめに（Getting Started）

前提条件（Prerequisites）

VOD2Live権限付きの有効なライセンスが必要です。ライセンスを持っていない場合は、Virtual Channelを評価したい場合は、https://www.unified-streaming.com/get-started でアカウントを作成してトライアルライセンスを取得できます。（もしくは、当社株式会社オルカプロダクションまでご連絡ください。）

その内容は、 UspLicenseKey 環境変数に設定されている必要があります。バーチャルチャンネルを起動するシェルで、次のコマンドを実行してください。

export UspLicenseKey = <ご自身のライセンスファイルの中身>

他の方法として、Virtual Channelのルートフォルダに含まれている .env ファイルに変数のデフォルト値を設定することもできます。

実行方法（How to run）

まず、 git を使用して Virtual Channel Repository をクローンします。

Virtual Channel is based on docker compose. As such, in order to run it you must make sure that the docker compose command is available in your system. Please notice that this is different from the legacy docker-compose (with a dash) command you may be used to, which has been recently deprecated by the docker project. In case it is not available on your system, refer to the Docker Compose installation documentation for instructions on how to install.

Virtual Channel は docker compose に基づいています。そのため、実行するにはシステム上で docker compose コマンドが使用可能であることを確認する必要があります。従来の docker-compose （ハイフン付き）のコマンドとは異なり、こちらは最近 Docker プロジェクトによって非推奨となった点に注意してください。システムに docker compose コマンドがない場合は、Docker Compose installation documentation を参照してインストール手順をご確認ください。

Note

➡️ Armサポート。Virtual Channelは、x86_64/arm64向けのマルチアーキテクチャ対応のAlpine Dockerイメージをベースにしています。つまり、M1ベースのMacなどでは、ネイティブアーキテクチャ用のイメージが使用され、エミュレーションレイヤーは不要です。

Note

デフォルトでは、Virtual Channel はOriginサービスにポート80、APIサービスにポート8000を使用します。起動する前に、これらのポートに他のサービスがバインドされていないことを確認してください。あるいは、ORIGIN_PORT および API_PORT 環境変数を上書きすることで、使用するポートを変更することもできます。

Virtual Channelサービスを起動するには、次のコマンドを実行します。

docker compose up -d

サービスが正しく稼働している場合、curl http://localhost:8000 を実行すると、 I'm alive メッセージが返されるはずです。

ドキュメントと使用方法（Documentation and Usage）

サービスが正しく起動している場合は、 http://localhost:8000/docs に詳細なオンラインドキュメントがあります。そこでは、利用可能なエンドポイントのリストが網羅されており、APIコールの作成やワークフローの定義に役立つ参考資料として使用できます。