ゲートウェイの環境変数

Keeperゲートウェイで利用できる環境変数

ゲートウェイのコア構成

CLIパラメータ
環境変数
デフォルト値
目的

-d, --debug

KEEPER_GATEWAY_LOG_LEVEL

info

ログレベルの設定。有効な値: debuginfowarningerrorcritical

--verbose

KEEPER_GATEWAY_VERBOSE

詳細ログを有効化

--log-file

KEEPER_GATEWAY_LOG_FILE

Generated based on timestamp

ログファイルのパスを指定

--log-folder

KEEPER_GATEWAY_LOG_FOLDER

~/.keeper/logs or /var/log/keeper-gateway for service

ログフォルダの場所を指定

--config-file, -c

GATEWAY_CONFIG_PATH

~/.keeper/gateway-config.json

ゲートウェイ構成ファイルへのパス

N/A

GATEWAY_CONFIG

None

Base64エンコードされた構成文字列

--aws-kms-secret-name

AWS_KMS_SECRET_NAME

None

構成用のAWS KMSシークレット名

N/A

VERIFY_SSL

TRUE

SSL証明書を検証するかどうか

N/A

KRELAY_SERVER

Auto-detected from config

TURN/STUNリレーサーバーを上書き

N/A

INSECURE_DEBUG

False

ログにパスワードを表示

--show-cmds

KEEPER_GATEWAY_SHOW_CMDS

False

実行中のコマンドを表示

--max-workers, -w

KEEPER_GATEWAY_MAX_WORKERS

1 for process pool, 10 for thread pool

ワーカープロセス/スレッド数

--log-to-stdout

KEEPER_GATEWAY_LOG_TO_STDOUT

False

ファイルではなくstdoutにログを出力

N/A

GUACD_HOST

127.0.0.1

guacdサービスのホスト

N/A

GUACD_PORT

4822

guacdサービスのポート

N/A

GUACD_PATH

pyguacd (Windows) or /opt/keeper/sbin/guacd (Linux)

guacd実行ファイルへのパス

--tunnel-only-use-turn

KEEPER_GATEWAY_TUNNEL_ONLY_USE_TURN

False

TURNリレーのみを強制使用

N/A

RECORDING_PATH

/recording_pipes

セッション録画のパス (セッション終了後に削除)

N/A

TYPE_SCRIPT_RECORDING_PATH

/recording_pipes

typescript録画のパス (セッション終了後に削除)

N/A

KEEPER_GATEWAY_CVE_SECURITY_CHECKS

false

初期化時にCVEセキュリティチェックを有効化

N/A

KEEPER_GATEWAY_USE_GUACR

false

標準ではなくGuacamole録画 (guacr) を使用

接続タイムアウト変数 (ゲートウェイ)

環境変数
デフォルト値
目的

KEEPER_GATEWAY_SET_LOCAL_DESCRIPTION_TIMEOUT

15s

WebRTCでローカル記述を設定するまでの時間

KEEPER_GATEWAY_OPEN_CONNECTION_TIMEOUT

60s

接続確立を待機する時間

KEEPER_GATEWAY_CREATE_ANSWER_TIMEOUT

30s

ピアICEアンサーを作成するまでの時間

KEEPER_GATEWAY_READ_TIMEOUT

15s

データチャネルからデータを待機する時間

KEEPER_GATEWAY_NON_PARED_READ_TIMEOUT

5s

ペアリング前にデータを待機する時間

KEEPER_GATEWAY_CLOSE_CONNECTION_TIMEOUT

5s

接続クローズを待機する時間

KEEPER_GATEWAY_TEST_CONNECTION_TIMEOUT

5s

テスト接続を待機する時間

KEEPER_GATEWAY_ABRUPT_DISCONNECTION_TIMEOUT

3s

突然の切断を検出するまでの時間

KEEPER_GATEWAY_FORCE_CLOSE_TIMEOUT

6s

接続を強制クローズするまでの時間

KEEPER_GATEWAY_RUST_CLEANUP_TIMEOUT

5s

Rustクリーンアップ操作の時間

KEEPER_GATEWAY_ACCEPT_OFFER_TIMEOUT

calculated

WebRTCオファーを受け入れるまでの時間 (create_answer + set_local_description + 10)

KEEPER_GATEWAY_RECORDINGS_PATH_TIMEOUT

20s

録画パスを作成するまでの時間

KEEPER_GATEWAY_GUACD_RECEIVE_TIMEOUT

15s

Guacamoleデーモンから受信するまでの時間

KEEPER_GATEWAY_DATA_CHANNEL_TIMEOUT

5s

データチャネル送信の時間

KEEPER_GATEWAY_CONNECTION_ESTABLISHMENT_TIMEOUT

15s

接続を確立するまでの時間

KEEPER_GATEWAY_JIT_ACCOUNT_CREATION_TIMEOUT

90s

JIT一時ユーザーの作成時間

KEEPER_GATEWAY_RECORDINGS_PATH_EPHEMERAL_TIMEOUT

60s

一時録画パスのセットアップ時間

Rust WebRTCモジュール (pam-rustwebrtc) の変数

バックエンドI/O構成

環境変数
デフォルト値
目的

KEEPER_GATEWAY_BACKEND_FLUSH_TIMEOUT_MS

50ms

backend flush() の完了を待機する最大時間

KEEPER_GATEWAY_MAX_FLUSH_FAILURES

5

接続を閉じるまでの連続フラッシュ失敗回数

KEEPER_GATEWAY_CHANNEL_SHUTDOWN_GRACE_MS

100ms

チューブクローズ時にシグナルチャネルが終了するまでの猶予期間

チャネルクリーンアップのタイムアウト

環境変数
デフォルト値
目的

KEEPER_GATEWAY_DATA_CHANNEL_CLOSE_TIMEOUT_SECS

3s

データチャネルクローズ操作のタイムアウト

KEEPER_GATEWAY_PEER_CONNECTION_CLOSE_TIMEOUT_SECS

5s

ピア接続クローズ操作のタイムアウト

KEEPER_GATEWAY_DISCONNECT_TO_EOF_DELAY_MS

100ms

Dropクリーンアップでの切断メッセージとEOFの間の遅延

ICE / 接続の確立

環境変数
デフォルト
目的

KEEPER_GATEWAY_ICE_GATHER_TIMEOUT_SECS

30s

初回接続のICE収集タイムアウト

KEEPER_GATEWAY_ICE_RESTART_ANSWER_TIMEOUT_SECS

10s

リモートピアからのICE再起動アンサーを待機するタイムアウト

KEEPER_GATEWAY_ICE_DISCONNECTED_WAIT_SECS

2s

ICE切断後、再起動をトリガーするまでの待機時間

アクティビティの監視

環境変数
デフォルト値
目的

KEEPER_GATEWAY_ACTIVITY_TIMEOUT_SECS

120s

ICE再起動を検討するまでの非アクティブ時間

KEEPER_GATEWAY_STALE_TUBE_SWEEP_INTERVAL_SECS

300s

古いチューブスイーパーの実行間隔

同時実行 / スケール

環境変数
デフォルト値
目的

KEEPER_GATEWAY_MAX_CONCURRENT_CREATES

100

許可される最大同時チューブ作成数

ルーター / HTTPタイムアウト

環境変数
デフォルト値
目的

KEEPER_GATEWAY_ROUTER_HTTP_TIMEOUT_SECS

5s

ルーターAPI呼び出しのHTTPタイムアウト

KEEPER_GATEWAY_TUBE_CREATION_TIMEOUT_SECS

15s

チューブ作成の合計タイムアウト

KEEPER_GATEWAY_ROUTER_CIRCUIT_BREAKER_COOLDOWN_SECS

60s

ルーター障害後のサーキットブレーカークールダウン

KEEPER_GATEWAY_ROUTER_CIRCUIT_BREAKER_THRESHOLD

3

サーキットブレーカーを開くまでの連続ルーター障害回数

WebRTCログ

環境変数
デフォルト値
目的

KEEPER_GATEWAY_INCLUDE_WEBRTC_LOGS

false

WebRTCライブラリログを含める (非常に詳細)。有効化するには "1" または "true" を設定

KPAM_ROUTER_HOST

Derived from KSM config

ルーターホスト名の上書き

ヘルスチェック変数

環境変数
デフォルト値
目的

KEEPER_GATEWAY_HEALTH_CHECK_ENABLED

false

ヘルスチェックサーバーを有効化

KEEPER_GATEWAY_HEALTH_CHECK_HOST

127.0.0.1

ヘルスチェックサーバーのバインドアドレス

KEEPER_GATEWAY_HEALTH_CHECK_PORT

8099

ヘルスチェックサーバーのポート

KEEPER_GATEWAY_HEALTH_CHECK_USE_SSL

false

ヘルスチェックでSSLを有効化

KEEPER_GATEWAY_HEALTH_CHECK_SSL_CERT

None

SSL証明書へのパス

KEEPER_GATEWAY_SSL_KEY

None

SSL秘密鍵へのパス

KEEPER_GATEWAY_HEALTH_CHECK_AUTH_TOKEN

None

ヘルスチェックAPIの認証トークン

リソース管理変数

環境変数
デフォルト値
目的

KEEPER_GATEWAY_RESOURCE_CHECK_ENABLED

true

リソース枯渇を防ぐためのリソースチェックを有効化

KEEPER_GATEWAY_MIN_HEADROOM_PERCENT

15

維持する最小メモリヘッドルーム率

KEEPER_GATEWAY_CHECK_RBI_CAPACITY

true

RBIセッションが利用可能リソースに収まるかチェック

KEEPER_GATEWAY_HTTP_RAM_MB

800

RBI/HTTP接続のRAM要件 (MB)

KEEPER_GATEWAY_RDP_RAM_MB

75

RDP接続のRAM要件 (MB)

KEEPER_GATEWAY_VNC_RAM_MB

65

VNC接続のRAM要件 (MB)

KEEPER_GATEWAY_SSH_RAM_MB

70

SSH接続のRAM要件 (MB)

KEEPER_GATEWAY_MYSQL_RAM_MB

35

MySQL接続のRAM要件 (MB)

KEEPER_GATEWAY_POSTGRESQL_RAM_MB

35

PostgreSQL接続のRAM要件 (MB)

KEEPER_GATEWAY_SQLSERVER_RAM_MB

35

SQL Server接続のRAM要件 (MB)

KEEPER_GATEWAY_KUBERNETES_RAM_MB

70

Kubernetes接続のRAM要件 (MB)

KEEPER_GATEWAY_TELNET_RAM_MB

50

Telnet接続のRAM要件 (MB)

KEEPER_GATEWAY_TUNNEL_RAM_MB

35

トンネル/ポートフォワーディングのRAM要件 (MB)

RBI (リモートブラウザ分離) 変数

環境変数
デフォルト値
目的

KEEPER_RBI_PROFILE_STORAGE_PATH

/opt/keeper/gateway/rbi-profiles

ブラウザセッション永続化プロファイルのディレクトリ

AI / 脅威検出変数

環境変数
デフォルト値
目的

KEEPER_GATEWAY_AI_LLM_PROVIDER

openai-generic

AI LLMプロバイダー (aws-bedrock, anthropic, google-ai, vertex-ai, openai, azure-openai, openai-generic)

KEEPER_GATEWAY_AI_MODEL

None (required)

AIモデル名/識別子

KEEPER_GATEWAY_AI_API_KEY

None (required)

AIプロバイダーのAPIキー

KEEPER_GATEWAY_AI_BASE_URL

None (optional)

AIプロバイダーAPIのベースURL

KEEPER_GATEWAY_AI_API_VERSION

None (required for Azure)

Azure OpenAIのAPIバージョン

KEEPER_GATEWAY_AI_RISK_LEVEL_SOURCE

None

リスクレベル分類のソース

RISK_CLASSIFIER_MODEL_DIR

None

リスク分類モデルを含むディレクトリ

KEEPER_GATEWAY_SENTRY_API_KEY

None

Sentry脅威検出のAPIキー

KEEPER_GATEWAY_SENTRY_BASE_URL

None

SentryサービスのベースURL

KEEPER_GATEWAY_SENTRY_MODEL

None

Sentryのモデル識別子

AWS Bedrock変数

環境変数
デフォルト値
目的

AWS_REGION

None (required)

BedrockのAWSリージョン

AWS_PROFILE

None (optional)

認証情報用のAWSプロファイル

AWS_ACCESS_KEY_ID

None (optional)

AWSアクセスキー

AWS_SECRET_ACCESS_KEY

None (optional)

AWSシークレットアクセスキー

AWS_SESSION_TOKEN

None (optional)

AWSセッショントークン

代替APIキー (プロバイダー固有)

環境変数
プロバイダ
目的

OPENAI_API_KEY

OpenAI

KEEPER_GATEWAY_AI_API_KEY の代替

ANTHROPIC_API_KEY

Anthropic

KEEPER_GATEWAY_AI_API_KEY の代替

AZURE_OPENAI_API_KEY

Azure OpenAI

KEEPER_GATEWAY_AI_API_KEY の代替

GOOGLE_API_KEY

Google AI

KEEPER_GATEWAY_AI_API_KEY の代替

KDNRMモジュール変数

ログ構成

環境変数
デフォルト値
目的

LOG_ENGINE

"default"

使用するログエンジンを指定

LOG_SHOW_STACKTRACE

FALSE

TRUEのとき、ログにPythonスタックトレース全体を表示

LOG_SHOW_LINE_NO

FALSE

TRUEのとき、ログ出力に行番号を表示

LOG_TO_FILE

None

ログを書き込むファイルパス

LOG_USAGE_SEC

0

メモリ使用量ログの間隔 (秒) (0 = 無効)

ローカルシークレットマネージャー構成

環境変数
デフォルト値
目的

USE_LOCAL_SM

FALSE

TRUEのとき、KSMサーバーの代わりにローカルSQLiteデータベースを使用

LOCAL_KSM_DEBUG

FALSE

ローカルシークレットマネージャーのデバッグログを有効化

LOCAL_SM_DB_FILE

None

ローカルシークレット用SQLiteデータベースファイルへのパス

LOCAL_SM_DIR

HOME or USERPROFILE

ローカルSQLiteデータベースを保存するディレクトリ

LOCAL_KSM_FALLBACK_SM

FALSE

TRUEのとき、ローカルDBが失敗した場合に実際のKSMサーバーにフォールバック

KSM_CONFIG

None

KSM構成ファイルへのパス

検出およびDAG構成

環境変数
デフォルト値
目的

USE_LOCAL_DAG

FALSE

TRUEのとき、リモートの代わりにローカルDAG/検出データベースを使用

LOCAL_DAG_DIR

HOME or USERPROFILE

ローカルDAGデータベースの保存ディレクトリ

LOCAL_DAG_DEBUG

FALSE

ローカルDAGのデバッグログを有効化

DAG_DEBUG_LEVEL

0

検出DAGのデバッグ詳細レベル (0-5)

DAG_RENDER

None

TRUEのとき、検出グラフの可視化をレンダリング

DUMP_DISCOVERY_JSON

FALSE

TRUEのとき、検出結果をJSONファイルにエクスポート

RULE_DEBUG

FALSE

ルールエンジン評価のデバッグログを有効化

ゲートウェイ構成

環境変数
デフォルト値
目的

GATEWAY_USER

Gateway.GATEWAY_USER constant

ゲートウェイ接続のユーザー (USER/USERNAMEにフォールバック)

KEEPER_GATEWAY_SAAS_PLUGIN_DIR

provider.saas_plugins_dir

カスタムSaaSプラグインのディレクトリ

KEEPER_GATEWAY_SERVICE_LOG_FINER_LEVEL

0

ユーザーをサービスにマッピングする際に表示するデバッグ情報の量を増やします。数値を大きくするとより多くの情報が表示されます。現在の最大値は3です。

Keeper DAGモジュール変数

デバッグと開発

環境変数
デフォルト値
目的

GS_DEBUG_LEVEL

0

デバッグレベルを上げます。数値が大きいほどより多くのデバッグ出力が生成されます

GS_IS_DEV

False

開発モードフラグ。Trueのとき、エッジ追加時に頂点名を表示

GS_CONN_DEBUG

False

GraphSync接続レベルのデバッグログを有効化

ルーターとサーバー接続

環境変数
デフォルト値
目的

ROUTER_HOST

Configured hostname from config

krouterのFQDNを上書き

KROUTER_URL

Derived from ROUTER_HOST

krouterへの完全なURL。設定時はROUTER_HOSTを上書き

USE_SSL

TRUE

krouterへの接続でSSL/TLSを使用するかどうかを決定

ローカルデータベース接続

環境変数
デフォルト値
目的

LOCAL_DAG_DB_FILE

'local_dag.db'

ローカルDAG接続のデータベースファイル名

トランザクションとログ

環境変数
デフォルト値
目的

GS_LOG_TRANS

False

ウェブサービス呼び出しのトランザクションログを有効化

GS_LOG_TRANS_DIR

"." (current directory)

トランザクションログファイルが作成されるディレクトリパス

Discovery Commonモジュール変数

環境変数
デフォルト値
目的

PROCESS_GS_DEBUG_LEVEL

None

プロセスグラフサービスのデバッグログレベルを制御

USE_KSM

FALSE

TRUEのとき、ローカル接続の代わりにKSM接続を使用

GRAPH_DIR

HOME, then PROFILENAME, then "."

グラフ可視化ファイルがレンダリングされるディレクトリ

サービス固有の環境変数

Windowsサービス

変数
目的

ProgramData

各種Windowsサービスパスの決定に使用

SystemRoot

Windowsシステムパスに使用

COMPUTERNAME

Windowsホスト名に使用

レガシータイムアウト変数 (非推奨 — KEEPER_GATEWAY_ プレフィックスを使用)

環境変数
デフォルト値
目的

SET_LOCAL_DESCRIPTION

15s

(非推奨) KEEPER_GATEWAY_SET_LOCAL_DESCRIPTION_TIMEOUT を使用

OPEN_CONNECTION_TIMEOUT_SEC

30s

(非推奨) KEEPER_GATEWAY_OPEN_CONNECTION_TIMEOUT を使用

CREATE_ANSWER_TIMEOUT_SEC

30s

(非推奨) KEEPER_GATEWAY_CREATE_ANSWER_TIMEOUT を使用

READ_TIMEOUT_SEC

5s

(非推奨) KEEPER_GATEWAY_READ_TIMEOUT を使用

NON_PARED_READ_TIMEOUT_SEC

5s

(非推奨) KEEPER_GATEWAY_NON_PARED_READ_TIMEOUT を使用

CLOSE_CONNECTION_TIMEOUT_SEC

5s

(非推奨) KEEPER_GATEWAY_CLOSE_CONNECTION_TIMEOUT を使用

TEST_CONNECTION_TIMEOUT_SEC

5s

(非推奨) KEEPER_GATEWAY_TEST_CONNECTION_TIMEOUT を使用

ACCEPT_OFFER_TIMEOUT_SEC

calculated

(非推奨) KEEPER_GATEWAY_ACCEPT_OFFER_TIMEOUT を使用

RECORDINGS_PATH_TIMEOUT_SEC

20s

(非推奨) KEEPER_GATEWAY_RECORDINGS_PATH_TIMEOUT を使用

最終更新