# WebRTC SFU Sora

## 概要

**Sora バージョン**: 2026.1.0

Sora Cloud で提供している Sora についてまとめています。

## Sora 最新バージョンの適用

### メジャーアップデート版

Sora Cloud の Sora はパッケージ版の Sora が正式リリースされた 1 ヶ月以内に最新版が利用可能になります。

> **注釈**
>
> Sora パッケージ版のメジャーアップデートは基本的に 6 月と 12 月に行います。

メジャーアップデート版のリリース時にはサービス停止を伴うメンテナンスを行う場合があります。
その場合は 1 ヶ月以上前にメンテナンス計画を共有します。

メンテナンス時間は長くても 3 時間で 14:00~17:00 の間に行います。

### バグフィックスアップデート版

Sora Cloud の Sora のバグフィックスアップデート版のデプロイはサイレントに行います。

サービス停止を伴うメンテナンスは基本的に行いません。

## Sora の互換性

シグナリングやウェブフックの破壊的変更は可能な限り行いません。

もし正式版の破壊的変更を行う場合は 1 年以上の移行期間をもうけます。

## Sora の実験的機能

Sora Cloud では Sora の実験的機能を利用する際、ご連絡いただく必要はありません。

## クラスター

- リレー機能が有効になっています
- クラスターアフィニティ機能が有効になっています

### クラスター数

Sora のクラスターは少なくとも 5 ノード以上のクラスターで構築されています。

## Sora API URL

**URL**: `https://api.sora-cloud.shiguredo.app/sora-api`

- `x-sora-target` ヘッダー- 利用する Sora API を指定してください

## シグナリング URL

シグナリング URL は以下の URL を利用してください。

**URL**: `wss://sora.sora-cloud.shiguredo.app/signaling`

### 複数のシグナリング URL

複数のシグナリング URL を利用することもできます。


```
wss://0001.sora.sora-cloud.shiguredo.app/signaling
wss://0002.sora.sora-cloud.shiguredo.app/signaling
wss://0003.sora.sora-cloud.shiguredo.app/signaling
```

## TURN URLs

**これらの値を意識していただく必要はありません**

- `turn://<シーケンス番号>.sora-turn.sora-cloud.shiguredo.app`
- `turns://<シーケンス番号>.sora-turn.sora-cloud.shiguredo.app`

## OBS Studio の WHIP

Sora Cloud では、OBS Studio の WHIP に対応しています。

利用する機能に応じて、以下のバージョンの OBS Studio をご利用ください。

- WHIP を利用する場合- 2024 年 7 月リリースの OBS Studio 30.2 以降
- WHIP サイマルキャストを利用する場合- 2026 年 3 月リリースの OBS Studio 32.1 以降

OBS Studio の WHIP については [Sora ドキュメント WHIP 機能](https://sora-doc.shiguredo.jp/WHIP) も参考にしてください。

### WHIP エンドポイント URL

Bearer Token にはアクセストークンを指定してください。

**URL**: `https://sora.sora-cloud.shiguredo.app/whip/<channel-id>`

### WHIP リソース URL

**これらの値を意識する必要はありません**

現時点では DELETE と PATCH メソッドに対応しています。

**URL**: `https://sora.sora-cloud.shiguredo.app/whip-session/<channel_id>/<secret>`

## OBS Studio の WHEP

現状 OBS Studio では WHEP に対応しておらず、開発中の機能です。

OBS Studio の WHEP については [Sora ドキュメント WHEP 機能](https://sora-doc.shiguredo.jp/WHEP) を参考にしてください。

### WHEP エンドポイント URL

Bearer Token にはアクセストークンを指定してください。

以下の URL をご利用ください。

**URL**: `https://sora.sora-cloud.shiguredo.app/whep/<channel-id>`

### WHEP リソース URL

**これらの値を意識する必要はありません**

現時点では DELETE と PATCH メソッドに対応しています。

**URL**: `https://sora.sora-cloud.shiguredo.app/whep-session/<channel_id>/<secret>`

## ヘルスチェック URL

Sora Cloud で提供している Sora は接続するクライアントが 0 のタイミングでサイレントでメンテナンスを行うため、
Sora のヘルスチェック機能の利用は推奨していません。

**それでも Sora のヘルスチェックが必要な場合はチケットを作成してください。**

## sora.conf

* - 項目名
  - 値
  - 備考
* - label
  - 設定済
  - 
* - ipv4_address
  - 設定済
  - 
* - ipv6
  - true
  -
* - ipv6_address
  - 設定済
  - 
* - multistream_auto_sharing_video_bit_rate
  - **false**
  - そのままの帯域が利用されますのでご注意ください
* - rtc_stats_log
  - 設定済
  -

### ウェブフック関連の設定

* - auth_webhook_url
  - 設定済
  - 
* - session_webhook_url
  - 設定済
  - 
* - event_webhook_url
  - 設定済
  - 
* - webhook_basic_authn
  - true
  - 
* - webhook_basic_authn_user_id
  - 設定済
  - 
* - webhook_basic_authn_password
  - 設定済
  - 
* - ignore_connection_failed_webhook
  - false
  - 
* - event_webhook_worker_number
  - 設定済み
  -

### シグナリング関連の設定

* - 項目名
  - 値
  - 備考
* - default_data_channel_signaling
  - true
  -
* - data_channel_signaling_close_message
  - true
  - 2024 年 12 月 18 日から true へ
* - data_channel_messaging
  - true
  -
* - data_channel_messaging_only
  - true
  -
* - signaling_vp9_params
  - true
  -
* - signaling_av1_params
  - true
  -
* - signaling_h264_params
  - true
  -
* - signaling_h265_params
  - true
  -
* - h264_b_frame
  - true
  -
* - h265_b_frame
  - true
  -
* - whip
  - true
  -
* - whep
  - true
  -
* - whip_bearer_token_metadata_key
  - access_token
  -
* - whep_bearer_token_metadata_key
  - access_token
  - 
* - signaling_forwarding_filters
  - true
  -
* - signaling_bundle_id
  - true
  -
* - simulcast_multicodec
  - true
  -

### 録画関連の設定

* - 項目名
  - 値
  - 備考
* - archive_dir
  - 設定済
  - 
* - archive_tmp_dir
  - 設定済
  - 
* - auth_webhook_recording
  - true
  -
* - recording_max_expire_time
  - 10800 s
  -
* - recording_max_split_duration
  - 10800 s
  -
* - recording_expire_time_required
  - true
  -
* - recording_dual_output
  - false
  -

### TURN 関連の設定

* - 項目名
  - 値
  - 備考
* - turn_realm
  - sora.sora-cloud.shiguredo.app
  - 
* - turn_fqdn
  - 設定済
  - 
* - turn_tcp_port
  - 設定済
  - 
* - turn_tls
  - true
  - 
* - turn_tls_fqdn
  - 設定済
  - 
* - turn_tls_port
  - 443
  -

### クラスター関連の設定

* - 項目名
  - 値
  - 備考
* - cluster
  - true
  - 
* - cluster_relay
  - true
  -
* - default_cluster_affinity
  - true
  -
* - cluster_affinity_threshold
  - 5
  -
* - node_name
  - 設定済
  -
* - external_signaling_url
  - 設定済
  -
* - external_api_url
  - 設定済
  -