デスクトップサーバ スタンドアロン

デスクトップサーバ スタンドアロン

このドキュメントではデスクトップサーバ フレームワークについて説明します。デスクトップサーバ統合の実行方法、証明書、セキュリティ、およびトラブルシューティングについて説明します。

デスクトップサーバ フレームワークは、Shotgun のローカル ファイル リンクと Toolkit の統合内で機能を提供します。デスクトップ アクセスを必要とするアクションに関して Shotgun Web サイトからの要求を安全にリッスンするローカル Websocket サーバを提供します。

ローカル ファイル リンクの場合、この要求により、Shotgun は Web インタフェースからローカル ファイル パスにアクセスし、要求時に Shotgun ページからこのファイルを直接開くことができます。Toolkit の場合、Shotgun は任意のエンティティに登録されたパイプライン アクションを特定し、そのアクションを実行できます。

デスクトップ統合を実行する方法

Shotgun の機能を動作させるには、サポートされたいくつかのデスクトップ統合を実行する必要があります。このページでは、Shotgun とデスクトップを統合するためのさまざまなオプションについて説明します。Websocket サーバのセクションでは、このフレームワークが提供する機能について説明します。

このサーバを実行するには、Shotgun Desktop またはスタンドアロンの 2 つの方法があります。

Shotgun Desktop

このフレームワークは Shotgun Desktop に付属し、ここからダウンロードすることができます。Shotgun Desktop を実行すると、Websocket サーバが自動的に起動されます。Shotgun Desktop を既に実行している場合、セットアップ プロセスは完了しています。

スタンドアロン サーバ

このフレームワークは、提供する機能がスタンドアロンで実行されるように作成されます。サーバを実行するには、このリポジトリのクローンを作成して実行します。

# Generates the certicicates
python app/certificates.py
# Runs the standalone server.
python app/app.py

Linux では Chrome の起動前に証明書を生成する必要があります。生成しないと、Chrome がローカル サーバと通信できなくなります。

スタンドアロン サーバを設定する

設定ファイルにブラウザ統合設定を保存できます。この設定ファイルを指定するには、--configuration コマンド ライン引数を使用するか、または環境変数 SGTK_BROWSER_INTEGRATION_CONFIG_LOCATION を設定します。ローカル サーバの設定方法については、サンプル ファイルを参照してください。

証明書を削除する

作成した証明書を削除する場合は、python certificates.py --remove コマンドを実行することができます。

ラッパーを使用して起動する

既定では、サーバはオペレーティング システムの既定値を使用してコマンド(Linux では「xdg-open」、OS X では「open」、Windows では「run」に相当)を起動します。ファイルを起動するために独自のラッパーを指定する場合は、カスタム ラッパーを指定するように環境変数 SHOTGUN_PLUGIN_LAUNCHER を設定します。設定されている場合は、ラッパーはその唯一の引数としてパスで呼び出されます。

証明書

サーバを初めて実行すると、安全な接続の確立に必要な証明書が生成されます。この証明書はマシンのローカルに保存され、一般的に共有されることはありません。証明書により、Web ソケットで必要とされる暗号化された接続が可能になります。これはすべてのトラフィックがローカル(ブラウザからサーバ)のままでも必要です。Shotgun の Web ソケット トラフィックはインターネットで利用可能になることはありません。

証明書がシステムに登録されると、次のようなダイアログが表示されます。「OK」をクリックすると、登録が続行されます。




Shotgun Desktop を使用する場合、生成された証明書は次の場所に保存されます。

OS X: ~/Library/Caches/Shotgun/desktop/config/certificates
Windows: %AppData%Shotgundesktopconfigcertificates
Linux: ~/.shotgun/desktop/config/certificates

スタンドアロン サーバを使用する場合、生成された証明書は既定では resources/keys フォルダに保存されます。

セキュリティ セットアップ - ローカル Shotgun インストール

既定では、Websocket サーバはポート 9000 でホストされる Shotgun サイトをリッスンするようにセットアップされます。ローカル Shotgun サーバを実行する場合、Websocket サーバからの接続を可能にするために Shotgun サーバの設定を更新する必要があります。

Shotgun Desktop を実行する場合は、Shotgun バイナリとともに使用する config.ini ファイルを設定する必要があります。このファイルの格納場所の詳細については、ここを参照してください。

このファイル内に Websocket サーバの機能を制御するセクションがあります。一般的な設定は次のようになります。

[BrowserIntegration]
low_level_debug=0
port=9000
enabled=1
whitelist=*.shotgunstudio.com

Desktop サーバのオプションの完全なリストと各オプションの簡単な説明については、ここをクリックしてください。

トラブルシューティング

Linux 上でサーバは libffi に依存しています。Desktop またはスタンドアロン サーバが起動時にクラッシュし、libffi が見つからないというメッセージがログに記録された場合は、このパッケージをインストールする必要があります。

セットアップ時の問題や質問については、support@shotgunsoftware.com までお問い合わせください。サーバの実行に関して問題が発生する場合は、config.ini ファイルの debug1 に設定して、Desktop のログ ファイルを追加します。

ログ ファイルは次の場所にあります。

OS X: ~/Library/Logs/Shotgun/tk-desktop.log
Windows: ~%APPDATA%Shotguntk-desktop.log
Linux: ~/.shotgun/tk-desktop.log

フォローする

0 コメント

ログインしてコメントを残してください。