Fixpoint マニュアル 目次

Ksbridge 利用マニュアル

株式会社フィックスポイント の Ksbridge 利用マニュアルです。

最終更新日: 2024/04/16

Ksbridge とは

Ksbridge は、プロキシサーバーを経由する環境下で Ksocket と Kompira cloud 間の通信を行えるようにするミドルウェアです。

Ksocket を使用するためには、Ksocket と Kompira cloud の間で WebSocket 通信を確立する必要があります。

Ksbridge は、インターネット接続においてプロキシサーバーを経由する環境下で Ksocket を実行する場合に Ksocket と Kompira cloud の間のブリッジとして動作します。

下図では Ksocket と Ksbridge 間の通信に 8080 ポート、Ksbridge とプロキシサーバー間の通信に 3128 ポートを記載していますが、各ポート番号は設定で変更できます。

使用方法

Ksbridge の使用方法について説明します。

Ksbridge のインストール

Ksbridge のダウンロード

使用している OS に対応する Ksbridge をダウンロードします。

ダウンロードは、Kompira シリーズ製品情報 > ダウンロード > Ksbridge ダウンロード より行います。

Ksbridge ファイルの展開

Ksbridge のファイルは .tar.gz ファイル形式となっているため、gzip 形式で解凍し tar 形式により展開します。

Ksbridge の起動

Ksbridge の起動の前に、使用している Kompira cloud とプロキシサーバーの情報について、下記項目を確認します。

今回は、値を例に Ksbridge のコマンドを記載し起動作業を行います。

コンソール画面で ksbridge.exe を起動します。

上表の項目を参考に、下記コマンドを入力します。

$ ./ksbridge -bind 127.0.0.1:8080 -host yourspace.cloud.kompira.jp 
-proxy http://username:password@your.proxyserver.co.jp:3128
********************************************************************************
ksbridge - Tiny websocket connection bridge server

  listen: ws://127.0.0.1:8080/api/ksocket/connect
  server: wss://yourspace.cloud.kompira.jp/api/ksocket/connect
  proxy:  http://username:password@your.proxyserver.co.jp:3128

********************************************************************************

プロキシサーバーへのアクセスにアカウントが必要ない場合は、以下のように指定します。

$ ./ksbridge -bind 127.0.0.1:8080 -host yourspace.cloud.kompira.jp 
-proxy http://your.proxyserver.co.jp:3128

実行すると、Ksbridge は Ksocket からの通信を待つ状態となります。

Ksocket の設定

Ksocket を Ksbridge に接続させる設定をします¹。

通常 Ksocket の設定ファイルには Kompira cloud のスペース URL を指定しますが、Ksbridge を使用する場合は、スペース URL を Ksbridge 側に設定します。

Ksocket の設定ファイルである ksocket.toml について以下の部分を編集します。

設定ファイルの配置場所は、Ksocket 利用マニュアル > 設定ファイル > Ksocket 設定 を参照してください。

[connect]
token = "FrKc+82kZGG9sdRS5AXnemXXXXXXXXXXX"
# Kompira cloud 上で発行した Ksocket トークンを設定する

protocol = "ws"
# "wss" から "ws" に変更する。設定行が存在しない場合は追加する

host = "127.0.0.1"   
# Ksbridge をインストールしたサーバーのアドレスに変更する

port = 8080
# Ksbridge の bind ポートに変更する

設定が完了したら、ksocket.toml の設定を反映するために Ksocket サービスを再起動します。

再起動については、Ksocket 利用マニュアル > コマンド使用方法 > サービスの管理 を参照してください。

再起動をすると、Ksocket は設定に従って設定したポートにアクセスします。

正常に接続ができた場合、Ksbridge では以下のような表示となります。

$ ./ksbridge -bind 127.0.0.1:8080 -host yourspace.cloud.kompira.jp 
-proxy http://username:password@your.proxyserver.co.jp:3128
********************************************************************************
ksbridge - Tiny websocket connection bridge server

  listen: ws://127.0.0.1:8080/api/ksocket/connect
  server: wss://yourspace.cloud.kompira.jp/api/ksocket/connect
  proxy:  http://username:password@your.proxyserver.co.jp:3128

********************************************************************************
INFO[0011] connecting to client...
INFO[0011] client has connected
INFO[0011] connecting to server...
INFO[0011] server has connected

接続の確認

接続を確認します。

Kompira cloud にアクセスし右上の人型マークから「設定 > Ksocket」をクリックします。

該当の Ksocket のステータスが「接続済み」となっていれば Ksocket は Ksbridge を介して正常に Kompira cloud に接続できています。

Ksbridge の停止

コンソール画面で Ctrl+C を入力すると Ksbridge は停止します。

トラブルシューティング

Ksbridge のトラブルシューティングについて記載します。

Ksbridge に何も出力されない

Ksocket を設定し再起動をしても Ksbridge にログが表示されない場合、Ksocket が Ksbridge と接続できていない可能性があります。

このような場合は、 Ksocket のログファイル（デフォルトであれば /opt/fixpoint/ksocket/var/log/ksocket/ksocket.log）を確認してください。

2018-12-12T19:40:13+0900  DEBUG  ksocket.channel.session:_connector:241  Resumer is waiting disconnection...
2018-12-12T19:40:13+0900  DEBUG  ksocket.channel.session:_connector:243  Disconnected from the peer. Resume connection...
2018-12-12T19:40:13+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...
2018-12-12T19:40:13+0900  WARNING  ksocket.channel.session:_resume:225  Failed to start/resume session: [Errno 111] Connect call failed ('127.0.0.1', 8080). Wait 0 sec... [1/120]
2018-12-12T19:40:13+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...
2018-12-12T19:40:13+0900  WARNING  ksocket.channel.session:_resume:225  Failed to start/resume session: [Errno 111] Connect call failed ('127.0.0.1', 8080). Wait 0 sec... [2/120]
2018-12-12T19:40:13+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...
2018-12-12T19:40:13+0900  WARNING  ksocket.channel.session:_resume:225  Failed to start/resume session: [Errno 111] Connect call failed ('127.0.0.1', 8080). Wait 0 sec... [3/120]

たとえば上記のようなログが Ksocket.log に出力され続けている場合、Ksbridge に接続できていない状態です。

ksocket.toml での設定を再度確認してください。

別のパターンとして以下のようなログが出力される場合があります。

2018-12-12T19:45:54+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...
2018-12-12T19:45:54+0900  WARNING  ksocket.channel.session:_resume:225  Failed to start/resume session: [SSL: UNKNOWN_PROTOCOL] unknown protocol (_ssl.c:833). Wait 0 sec... [1/120]
2018-12-12T19:45:54+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...
2018-12-12T19:45:55+0900  WARNING  ksocket.channel.session:_resume:225  Failed to start/resume session: [SSL: UNKNOWN_PROTOCOL] unknown protocol (_ssl.c:833). Wait 0 sec... [2/120]
2018-12-12T19:45:55+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...
2018-12-12T19:45:55+0900  WARNING  ksocket.channel.session:_resume:225  Failed to start/resume session: [SSL: UNKNOWN_PROTOCOL] unknown protocol (_ssl.c:833). Wait 0 sec... [3/120]
2018-12-12T19:45:55+0900  DEBUG  ksocket.channel.session:_resume:213  Connecting to the peer. Wait 60.000000 seconds...

上記の場合は、ksocket.toml に protocol: ws という接続方式を変更する設定が正しく読み込まれていません。

Ksocket 利用マニュアル > 設定ファイル > Ksocket 設定 を確認し、protocol 行を設定してください。

「failed to connect server」と表示される

Ksbridge のログで、failed to connect server と表示される場合、Ksocket と Ksbridge は疎通できているものの、Ksbridge とプロキシサーバー間の通信が確立できていない場合が考えられます。

$ ./ksbridge -bind 127.0.0.1:8080 -host yourspace.cloud.kompira.jp -proxy http://username:password@no.proxyserver.co.jp:3128
********************************************************************************
ksbridge - Tiny websocket connection bridge server

  listen: ws://127.0.0.1:8080/api/ksocket/connect
  server: wss://yourspace.cloud.kompira.jp/api/ksocket/connect
  proxy:  http://username:password@no.proxyserver.co.jp:3128

********************************************************************************
INFO[0012] connecting to client...
INFO[0012] client has connected
INFO[0012] connecting to server...
ERRO[0012] failed to connect server                      err="dial tcp: lookup no.proxyserver.co.jp on 10.10.10.0:53: no such host" uri="{wss   yourspace.cloud.kompira.jp /api/ksocket/connect  false  }"
INFO[0069] connecting to client...
INFO[0069] client has connected
INFO[0069] connecting to server...
ERRO[0069] failed to connect server                      err="dial tcp: lookup no.proxyserver.co.jp on 10.10.10.0:53: no such host" uri="{wss   yourspace.cloud.kompira.jp /api/ksocket/connect  false  }"

上記の場合は、Ksbridge の実行時に指定しているプロキシサーバーのサーバー名、アカウント、パスワード等が正しいかどうかを確認してください。

仕様情報

Ksbridge のシステム要件について記載します。

システム要件

通信要件

導入・設定