MENU

Soracom

Users

soratun 設定ファイルリファレンス

SORACOM Arc クライアント soratun の設定ファイル(デフォルト arc.json)のスキーマです。手動で編集できますが一貫性のない変更を行った場合接続できなくなる可能性があります。可能な限り soratun bootstrap コマンドを使用してください。

PropertyTypeRequiredDescription
enableMetricsbooleanYes有効にした場合、ログレベルが error または verbose の際に標準出力にメトリックスを約 60 秒毎に出力します。
interfacestringYessoratun が作成するインターフェース名。macOS でテストする場合、OS の制限のため utun で始まる文字列を指定してください。
logLevelintegerYesログレベル (0: 出力無し / 1: エラーのみ出力 / 2: デバッグ情報も出力)
privateKeystringYesWireGuard 秘密鍵。通常は編集しないでください。
publicKeystringYesWireGuard 公開鍵。通常は編集しないでください。
additionalAllowedIPsstring[]Nosoratun 作成時に WireGuard の AllowedIPs に追加する CIDR の配列。このネットワーク宛の通信も soratun 経由になります。
arcSessionStatusobjectNoSORACOM Arc 接続情報。自動的に生成または更新されますので通常は編集しないでください。
profileobjectNoSORACOM API 接続情報。soratun bootstrap authkey を実行した際に保存されます。その他のブートストラップ方法では使用されません。
simIdstringNoバーチャル SIM の SIM ID

arcSessionStatus

SORACOM Arc 接続情報。自動的に生成または更新されますので通常は編集しないでください。

PropertyTypeRequiredDescription
arcAllowedIPsstring[]YesSORACOM Arc サーバーから受信した WireGuard AllowedIPs の配列
arcClientPeerIpAddressstringYesクライアントの IP アドレス
arcServerEndpointstringYesSORACOM Arc サーバーの UDP エンドポイント (IP アドレスまたはホスト名:ポート番号)
arcServerPeerPublicKeystringYesSORACOM Arc サーバーの WireGuard 公開鍵

profile

SORACOM API 接続情報。soratun bootstrap authkey を実行した際に保存されます。その他のブートストラップ方法では使用されません。

PropertyTypeRequiredDescription
authKeyIdstringYesSORACOM API 認証キー ID
authKeystringYesSORACOM API 認証キーシークレット
endpointstringYesSORACOM API のエンドポイント。Global カバレッジ: https://g.api.soracom.io / Japan カバレッジ: https://api.soracom.io