# WSSサーバー設定ファイル（wss-config.yml）

WSSサーバー設定ファイル（wss-config.yml）では、HULFT10 Smart Proxy（WSS）を使用するために、識別情報、通信、セキュリティ、ログおよびデータベース関連の項目を設定します。設定ファイルの更新はテキストエディタで行ってください。

WSSサーバー設定ファイル（wss-config.yml）は以下にあります。

    $HULFT_SMART_PROXY_HOME/etc/wss-config.yml

## 項目一覧

WSSサーバー設定ファイル（wss-config.yml）の設定項目は以下のとおりです。

表5.2 WSSサーバー設定ファイル（wss-config.yml）

項目名 | タグ名 | 初期値 | 設定値 | 要否
--- | --- | --- | --- | ---
識別情報定義 |  |  |  |
自ホスト名 | hostname | ホスト名 | 255バイト以内 | 必須
サービス名 | servicename | （サービス名なし） | 英数字。100バイト以内 |
通信関連定義 |  |  |  |
HULFT接続用 bind ip | inner-bind-ip | 0.0.0.0 | IPv4 | 必須
HULFT接続用 受付ポート | inner-port | 30001 | 1～65535 | 必須
WebSocket接続用 bind ip | outer-bind-ip | 0.0.0.0 | IPV4、v6 | 必須
WebSocket接続用 受付ポート | outer-port | 42000 | 1～65535 | 必須
ソケットリードタイムアウト | socket-read-timeout-sec | 600 | 60～600 | 必須
ソケット接続リトライ待ち時間 | connection-retry-waittime-sec | 30 | 30～600 | 必須
ソケット接続リトライ回数 | connection-retry-num | 10 | 0～10 | 必須
セキュリティ定義 |  |  |  |
サーバー証明書 | tls-cert-path |  |  | 必須
秘密鍵 | tls-key-path |  |  | 必須
障害運用情報定義 |  |  |  |
ログㇾベル | level | info | info、warn、error | 必須
ファイルパス | filepath |  | ファイルパスとして有効な文字列 | 必須
ファイルサイズ | max-size | 100 | 1以上の正数値 | 必須
バックアップファイル数 | max-backups | 0 | 0以上の正数値 | 必須
データベース関連定義 |  |  |  |
データベースドライバー | db-driver | postgres |  | 必須
データベース名 | dbname | hulsp | 利用するデータベースによる | 必須
ユーザー名 | user |  | 利用するデータベースによる | 必須
パスワード | password |  | 利用するデータベースによる | 必須
ホスト名 | host |  |  | 必須
ポート番号 | port | 5432 | 1～65535 | 必須
SSLモード | ssl-mode |  | disable、enable | 必須
接続時間 | connect-timeout | 30 |  | 必須
クライアントSSL証明書 | ssl-cert |  |  |
クライアントSSL秘密鍵 | ssl-key |  |  |
SSLルート証明書 | ssl-root-cert |  |  |

## 各項目の説明

WSSサーバー設定ファイルの各項目について説明します。

### 識別情報定義

自ホスト名（hostname）

  自サーバーのホスト名

  この項目は、転送先の決定や、出力先の指定に使用されます。

  HULFT10 Smart Proxyのあるネットワーク内でユニークな名前を付与してください。

サービス名（servicename）

  自サービスのサービス名

  同一ホスト内で複数のサーバーを立ち上げる場合の識別に使用されます。

### 通信関連定義

HULFT接続用 bind ip（inner-bind-ip）

  HULFTから接続するためのbind IPアドレス

HULFT接続用 受付ポート（inner-port）

  HULFTに接続するための受付ポート

WebSocket接続用 bind ip（outer-bind-ip）

  WebSocketから接続するためのbind IPアドレス

WebSocket接続用 受付ポート（outer-port）

  WebSocketに接続するための受付ポート

ソケットリードタイムアウト（socket-read-timeout-sec）

  ソケット通信中に相手ホストから応答がない場合のタイムアウト時間（単位：秒）

  HULFT10 Smart Proxy間でセッションが切れないよう、キープアライブの処理に使用されます。

  タイムアウトした場合は、通信異常として通信が切断されます。ネットワークの異常を検知するための時間なので、ご使用のネットワークに適した値を設定してください。

ソケット接続リトライ待ち時間（connection-retry-waittime-sec）

  コネクション接続のリトライ処理の実行間隔（単位：秒）

  ソケット接続に失敗したとき、再接続を試みるまでの待ち時間を指定します。

ソケット接続リトライ回数（connection-retry-num）

  コネクション接続のリトライ回数を指定する。

  ソケット接続に失敗したとき、再接続を行う回数を指定します。

  “0”を指定した場合、再接続は行いません。

### セキュリティ定義

サーバー証明書（tls-cert-path）

  サーバーがhttpsサーバーとして利用するSSL証明書

秘密鍵（tls-key-path）

  サーバーがhttpsサーバーとして利用するSSL秘密鍵

### 障害運用情報定義

ログㇾベル（level）

  アプリケーションログの出力レベル

  info

    : 正常に動作していることを把握するための情報が表示

  warn

    : システムの動作に影響する可能性がある問題を特定するための情報が表示

  error

    : エラーの内容や対処方法など、システムの復旧を目的とした情報が表示

  出力されるログの優先度は以下のとおりです。

      ←優先度低   優先度高→

      info  <  warn  <  error

  優先度が指定したログレベル以上のログが出力されます。

  例）ログㇾベル（level）に“warn”を指定した場合、“info”のログは出力されません。“warn”および“error”のログが出力されます。

ファイルパス（filepath）

  アプリケーションログの出力先となるファイルパス

  フルパスでの入力をお勧めします。

ファイルサイズ（max-size）

  アプリケーションログがローテーションされるファイルサイズ（単位：MB）

バックアップファイル数（max-backups）

  アプリケーションログがローテーションされ保持する古いログファイルの最大数

### データベース関連定義

データベースドライバー（dbDriver）

  データベースの接続に使用するドライバー名

データベース名（dbname）

  アプリケーションで使用するデータベース名

ユーザー名（user）

  データベースの接続に使用するユーザー名

パスワード（password）

  データベースの接続に使用するパスワード

ホスト名（host）

  接続するデータベースのホスト名

ポート番号（port）

  接続するデータベースのポート番号

SSLモード（ssl-mode）

  接続にSSL/TLSを使用するかどうか、またどのように使用するかの制御を指定

  データベースの仕様で決まっている文字列が指定できます。

接続時間（connect-timeout）

  データベースとの接続の確立がタイムアウトするまでの最大時間（単位：秒）

  “0”を指定すると、タイムアウトは発生しません。

クライアントSSL証明書（ssl-cert）

  クライアント認証を行う場合のクライアントSSL証明書のファイルパス

  クライアント認証をする際は必須です。

クライアントSSL秘密鍵（ssl-key）

  クライアントSSL証明書に対応する秘密鍵のファイルパス

  クライアント認証をする際は必須です。

SSLルート証明書（ssl-root-cert）

  サーバー証明書の認証に使用するCA証明書のファイルパス