トンネル実行パラメータ
このページでは、Cloudflareトンネルの一般的な構成オプションをリストします。これらのフラグをcloudflared tunnel runコマンドに追加して、リモート管理およびローカル管理トンネルに使用できます。これらのフラグは、構成ファイルにキー/値ペアとして追加することもできます。
| 構文 | デフォルト |
|---|---|
cloudflared tunnel --autoupdate-freq <FREQ> run <UUID or NAME> | 24h |
cloudflaredの更新頻度を設定します。
デフォルトでは、cloudflaredは定期的に更新をチェックし、新しいバージョンで再起動します。再起動は、Cloudflareのグローバルネットワークに接続する新しいプロセスを生成することで行われます。接続が成功すると、古いプロセスは未処理のリクエストをすべて処理した後、優雅にシャットダウンします。詳細については、no-autoupdateを参照してください。
| 構文 | デフォルト |
|---|---|
cloudflared tunnel --config <PATH> run <UUID or NAME> | ~/.cloudflared/config.yml |
YAML形式の構成ファイルへのパスを指定します。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel --edge-bind-address <IP> run <UUID or NAME> | TUNNEL_EDGE_BIND_ADDRESS |
cloudflaredとCloudflareのグローバルネットワーク間の接続を確立するために使用される送信IPアドレスを指定します。
デフォルトでは、cloudflaredはオペレーティングシステムにどのIPアドレスを使用するかを決定させます。このオプションは、複数のネットワークインターフェースが利用可能で、特定のインターフェースを優先したい場合に便利です。
edge-bind-addressのIPバージョンは、edge-ip-version(指定されている場合)を上書きします。たとえば、IPv6ソースアドレスを入力すると、cloudflaredは常にIPv6宛先に接続します。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --edge-ip-version <VERSION> run <UUID or NAME> | auto | TUNNEL_EDGE_IP_VERSION |
cloudflaredとCloudflareのグローバルネットワーク間の接続を確立するために使用されるIPアドレスのバージョン(IPv4またはIPv6)を指定します。利用可能な値はauto、4、および6です。
値autoは、ホストオペレーティングシステムにどのIPバージョンを選択するかを決定させます。地域のルックアップのDNS解決から返された最初のIPバージョンがプライマリセットとして使用されます。デュアルIPv6およびIPv4ネットワークセットアップでは、cloudflaredはIPバージョンを2つのアドレスセットに分け、接続障害シナリオでフォールバックに使用します。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --grace-period <PERIOD> run <UUID or NAME> | 30s | TUNNEL_GRACE_PERIOD |
cloudflaredがSIGINT/SIGTERMを受信すると、新しいリクエストの受け入れを停止し、進行中のリクエストが終了するのを待ってからシャットダウンします。進行中のリクエストの待機は、この猶予期間後、または2回目のSIGTERM/SIGINTを受信したときにタイムアウトします。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel --logfile <PATH> run <UUID or NAME> | TUNNEL_LOGFILE |
アプリケーションログをこのファイルに保存します。主に問題報告に役立ちます。Cloudflareサポートに連絡する際に必要な情報の詳細については、このガイドを参照してください。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --loglevel <VALUE> run <UUID or NAME> | info | TUNNEL_LOGLEVEL |
ログの詳細度を指定します。デフォルトのinfoレベルはあまり出力を生成しませんが、プロダクションではwarnレベルを使用することをお勧めします。利用可能な値は、debug、info、warn、error、fatalです。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --metrics <IP:PORT> run <UUID or NAME> | localhost: | TUNNEL_METRICS |
指定されたIPアドレス/ポートでPrometheusエンドポイントを公開し、使用状況メトリクスをクエリできます。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel --no-autoupdate run <UUID or NAME> | NO_AUTOUPDATE |
自動cloudflared更新を無効にします。詳細については、autoupdate-freqを参照してください。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --origincert <PATH> run <UUID or NAME> | ~/.cloudflared/cert.pem | TUNNEL_ORIGIN_CERT |
ゾーンの1つのためのアカウント証明書を指定し、そのゾーンのオリジンとしてクライアントを認証します。cloudflared tunnel loginコマンドを使用するか、https://dash.cloudflare.com/argotunnelを訪問することで証明書を取得できます。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel --pidfile <PATH> run <UUID or NAME> | TUNNEL_PIDFILE |
最初の成功した接続後にアプリケーションのプロセス識別子(PID)をこのファイルに書き込みます。主にスクリプトやサービス統合に役立ちます。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --protocol <VALUE> run <UUID or NAME> | auto | TUNNEL_TRANSPORT_PROTOCOL |
cloudflaredとCloudflareのグローバルネットワーク間の接続を確立するために使用されるプロトコルを指定します。利用可能な値はauto、http2、およびquicです。
auto値は、quicプロトコルを自動的に構成します。cloudflaredがUDP接続を確立できない場合、http2プロトコルにフォールバックします。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel --region <VALUE> run <UUID or NAME> | TUNNEL_REGION |
接続を確立する地域を選択できます。現在利用可能な値はusのみで、すべての接続がアメリカのデータセンターを経由します。グローバル地域に接続するには、省略するか空のままにします。
| 構文 | デフォルト | 環境変数 |
|---|---|---|
cloudflared tunnel --retries <VALUE> run <UUID or NAME> | 5 | TUNNEL_RETRIES |
接続/プロトコルエラーの最大再試行回数を指定します。再試行は指数バックオフを使用し(デフォルトでは1、2、4、8、16秒で再試行)、この値を大幅に増やすことは推奨されません。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel --tag <KEY=VAL> run <UUID or NAME> | TUNNEL_TAG |
このトンネルを識別するために使用されるカスタムタグを指定します。複数のタグを指定するには、コマンドに追加の--tag <KEY=VAL>フラグを追加します。構成ファイルに複数のタグを入力する場合は、カンマで区切ります:tag: {KEY1=VALUE1, KEY2=VALUE2}。
| 構文 | 環境変数 |
|---|---|
cloudflared tunnel run --token <TUNNEL_TOKEN> | TUNNEL_TOKEN |
特定のトンネルにcloudflaredインスタンスを関連付けます。トンネルのトークンは、最初にトンネルを作成する際にダッシュボードに表示されます。また、APIを使用してトークンを取得することもできます。