開発ツール¶

概要¶

Sora DevTools は時雨堂が開発し Apache-2.0 ライセンスとしてオープンソースで公開している Sora の開発者向けのツールです。

このツールは、Sora の機能を試したり、アプリケーションの開発中に機能を確認したり、Sora で何か問題が発生した場合に再現を行うために利用できます。

Sora DevTools はオンライン版とオフライン版の 2 種類があります。

オンライン版はブラウザから直接アクセスして利用できます。

オフライン版は閉鎖ネットワーク環境下などで、オンライン版にアクセスできない場合に、ローカルに NGINX でホスティングして利用できます。

Sora DevTools オンライン版を利用する¶

Sora DevTools のオンライン版は、 https://sora-devtools.shiguredo.app へアクセスし、 signalingUrlCandidates に Sora のシグナリング URL を指定することで利用できます。

Sora DevTools オンライン版を NGINX でリバースプロキシして利用する¶

警告

商用環境ではこの設定は利用せず、開発環境でのみ有効にしてください。

NGINX の location / ディレクティブで https://sora-devtools.shiguredo.app へリバースプロキシしてください。

location / {
    proxy_http_version 1.1;
    proxy_pass https://sora-devtools.shiguredo.app;
    proxy_set_header Host sora-devtools.shiguredo.app;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;

    proxy_ssl_server_name on;
    proxy_ssl_name sora-devtools.shiguredo.app;
    proxy_ssl_protocols TLSv1.2 TLSv1.3;
}

Sora DevTools オフライン版を NGINX でホスティングして利用する¶

警告

商用環境ではこの設定は利用せず、開発環境でのみ有効にしてください。

https://github.com/shiguredo/sora-devtools/releases/latest から sora-devtools-<version>.tar.gz をダウンロードして解凍してください。

解凍したディレクトリを NGINX の root ディレクティブに指定してください。

location / {
    root /path/to/sora-devtools-<version>;
    index index.html;
    try_files $uri $uri/ /index.html;
}

Sora DevTools オフライン版を Python3 でホスティングして利用する¶

ローカルで簡単に動かしたい場合はこの方法がおすすめです。

https://github.com/shiguredo/sora-devtools/releases/latest から sora-devtools-<version>.tar.gz をダウンロードして解凍してください。

cd /path/to/sora-devtools-<version>
python3 -m http.server 8000

ブラウザから http://localhost:8000 にアクセスすることで利用できます。 signalingUrlCandidates に Sora のシグナリング URL を指定することで利用できます。

サポート¶

Sora DevTools の正式版については、 Sora のサポート対象です
Sora DevTools の開発版については、 Sora のサポート対象外です

Discord¶

https://discord.gg/shiguredo

Discord にてコミュニティを運営しています。なにか質問したい場合は Discord サーバーへ参加してください。

開発ツールの開発版についての質問やバグ報告は Discord の #sora-tool-faq チャンネルにお願いします。