Cloudflare Tunnel クライアント

Cloudflare Tunnel のコマンドラインクライアントを含みます。これは、Cloudflare ネットワークからオリジンへのトラフィックをプロキシするトンネリングデーモンです。 このデーモンは Cloudflare ネットワークとオリジン (例: Web サーバー) の間に位置します。Cloudflare はクライアントリクエストを引き寄せ、このデーモンを介して それらをあなたに送信します。ファイアウォールに穴を開ける必要はなく、オリジンは可能な限り閉じたままにできます。 詳細なドキュメントは Cloudflare Docs の Cloudflare Tunnel セクションにあります。 オリジンへのプロキシに関するすべての使用方法は cloudflared tunnel help で確認できます。

また、cloudflared を使用して、レイヤー4 (つまり HTTP/websocket ではない) の TCP トラフィック向けに (cloudflared tunnel で保護された) Tunnel オリジンにアクセスすることもできます。これは SSH や RDP などのユースケースに関連します。 そのような使用方法は cloudflared access help で確認できます。

代わりに WARP クライアントを使用すると、クライアント側で cloudflared access コマンドを必要とせずに、レイヤー4 トラフィック向けの Tunnel の背後にあるプライベートオリジンにアクセスできます。

はじめる前に

Cloudflare Tunnel を使用する前に、Cloudflare ダッシュボードでいくつかの手順を完了する必要があります。Cloudflare アカウントに ウェブサイトを追加する必要があります。現在ではウェブサイトなしで Tunnel を使用することも可能ですが (例: プライベート ルーティング)、レガシーな理由によりこの要件は依然として必要です:

1. Cloudflare にウェブサイトを追加する
2. ドメインのネームサーバーを Cloudflare に変更する

cloudflared のインストール

ダウンロードは、スタンドアロンバイナリ、Docker イメージ、および Debian、RPM、Homebrew パッケージとして利用可能です。リリースは cloudflared GitHub リポジトリの こちらでも確認できます。

• Homebrew 経由、または 最新の Darwin amd64 リリースをダウンロードすることで macOS にインストールできます
• Linux 用のバイナリ、Debian、RPM パッケージはこちらにあります
• cloudflared の Docker イメージは DockerHub で利用可能です
• Windows マシンにはこちらの手順でインストールできます
• ソースからビルドするには、以下の開発セクションに記載されている必要なバージョンの go をインストールしてください。その後 make cloudflared を実行できます。

Cloudflare Tunnel のユーザードキュメントは https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/ にあります。

Tunnel の作成とトラフィックのルーティング

インストール後、cloudflared を Cloudflare アカウントに認証し、オリジンにトラフィックを配信する Tunnel の作成を開始できます。

• こちらの手順で Tunnel を作成します
• その Tunnel にトラフィックをルーティングします:
  • Cloudflare のパブリック DNS レコード経由
  • または Cloudflare Load Balancer によって誘導されるパブリックホスト名経由
  • または WARP クライアントのプライベートトラフィックから

TryCloudflare

Cloudflare にウェブサイトを追加する前に Cloudflare Tunnel をテストしたい場合は、こちらで利用可能なドキュメントを使用して TryCloudflare で行えます。

破壊的変更

CLI フラグ、環境変数、設定キー、またはコマンドの削除は破壊的 変更です。そのような削除は、それらを削除するリリースの前に Cloudflare Tunnel チェンジログで告知する必要があります。

非推奨バージョン

Cloudflare は現在、最新リリースから1年以内の cloudflared のバージョンをサポートしています。機能の可用性とは無関係の破壊的変更が導入される可能性があり、1年以上前にリリースされたバージョンに影響を与えます。cloudflared のアップグレードについて詳しくは、開発者ドキュメントをご覧ください。

例えば、2023年1月時点で Cloudflare は cloudflared バージョン 2023.1.1 から cloudflared 2022.1.1 をサポートします。

開発

要件

• GNU Make
• capnp
• go >= 1.27
• オプションのツール:
  • capnpc-go
  • goimports
  • golangci-lint
  • gomocks

ビルド

cloudflared をローカルでビルドするには make cloudflared を実行します

テスト

ローカルでテストを実行するには make test を実行します

リンティング

コードをフォーマットし、良好なコード品質を保つには make fmt と make lint を使用します

モック

インターフェースを変更した後、モックを再生成する必要がある場合があるため、make mocks を実行します

Git フック

CI エラーを避けるために、各プッシュ前にリンティングとテストを実行する pre-push フックをインストールできます:

make install-hooks

これにより、各プッシュ前に make fmt-check lint test を実行する .githooks/ 内のフックを使用するように git が設定されます。