Ksocket 設定

Ksocket は起動時に Ksocket インストール先の $KSOCKET_HOME/etc/ksocket/ksocket.toml に記載された設定を読み込みます。

インストール先がデフォルトの場合、 $KSOCKET_HOME は以下になります。

  • Windows:C:\ProgramData\Fixpoint\ksocket
  • Linux:/opt/fixpoint/ksocket

設定の確認・変更には 設定コマンド が利用できます。

Windows では設定ファイルの編集にメモ帳が利用できますが、その際には「管理者として実行」するよう注意してください。

注意

下記にて明言されていない設定項目も存在しますが、内部的な項目のため変更しないでください。

logfile

ログファイルの書き込み先ファイルを指定します。

値として - を指定した場合、ファイルではなく標準出力に結果を書き出します。

デフォルト値は $KSOCKET_HOME/var/log/ksocket/ksocket.log です。

ksocket コマンドとして実行する場合は --logfile={VALUE} というコマンド引数で上書きできます。

また、以下の特殊変数が利用可能です。

  • $KSOCKET_HOME:Ksocket のインストール先ディレクトリパス

loglevel

ログの出力レベルを DEBUG, INFO, WARNING, ERROR, CRITICAL から指定します。

検証時は DEBUGINFO、運用時は WARNING 以上に設定することをお勧めします。

デフォルト値は INFO です。

ksocket コマンドとして実行する場合は --loglevel={VALUE} というコマンド引数で上書きできます。

connect.token

Kompira cloud との接続時に利用する Ksocket トークンを指定します。

Ksocket トークンの発行は Ksocket トークンの発行 を参照してください。

connect.host

接続先の Kompira cloud スペースを FQDN で指定します。

例えば、スペース名が fixpoint の場合は fixpoint.cloud.kompira.jp となります。

connect.port

Kompira cloud との接続時に利用するポート番号を指定します。

特別な事情がない限り 443 を利用してください。

デフォルト値は 443 です。

connect.protocol

Kompira cloud との接続時に利用するプロトコルを wss, ws から指定します。

特別な事情がない限り wss を利用してください。

デフォルト値は wss です。

operations.networksScanMode

ネットワークスキャンの際に利用するモードを intranet, azure, aws から指定します。

スキャン対象のネットワーク種類によって切り替えてください。

  • intranet:社内ネットワーク等のローカルネットワークをスキャンする場合
  • azure:Microsoft Azure (Azure) 上の Azure Virtual Machine (Azure VM) インスタンスを API 経由でスキャンする場合
  • aws:AWS 上の Amazon EC2 インスタンスを API 経由でスキャンする場合
  • googlecloud:Google Cloud の Google Compute Engine (GCE)インスタンスを API 経由でスキャンする場合

directories.credentials

クレデンシャルファイルの保存先ディレクトリを指定します。

デフォルト値は $KSOCKET_HOME/etc/ksocket/credentials です。

以下の特殊変数が利用可能です。

  • $KSOCKET_HOME:Ksocket のインストール先ディレクトリパス