Client Cloudflare Tunnel

Contient le client en ligne de commande pour Cloudflare Tunnel, un démon de tunneling qui achemine le trafic depuis le réseau Cloudflare vers vos origines. Ce démon se situe entre le réseau Cloudflare et votre origine (par exemple un serveur web). Cloudflare attire les requêtes des clients et vous les envoie via ce démon, sans que vous ayez besoin d'ouvrir des trous dans votre pare-feu --- votre origine peut rester aussi fermée que possible. Une documentation détaillée est disponible dans la section Cloudflare Tunnel de la documentation Cloudflare. Tous les usages liés au proxy vers vos origines sont disponibles sous cloudflared tunnel help.

Vous pouvez également utiliser cloudflared pour accéder aux origines Tunnel (qui sont protégées par cloudflared tunnel) pour le trafic TCP au niveau 4 (c'est-à-dire, pas HTTP/websocket), ce qui est pertinent pour des cas d'usage tels que SSH, RDP, etc. Ces usages sont disponibles sous cloudflared access help.

Vous pouvez plutôt utiliser le client WARP pour accéder aux origines privées derrière les Tunnels pour le trafic de niveau 4 sans nécessiter les commandes cloudflared access côté client.

Avant de commencer

Avant d'utiliser Cloudflare Tunnel, vous devrez effectuer quelques étapes dans le tableau de bord Cloudflare : vous devez ajouter un site web à votre compte Cloudflare. Notez qu'aujourd'hui il est possible d'utiliser Tunnel sans site web (par exemple pour un routage privé), mais pour des raisons historiques cette exigence reste nécessaire :

1. Ajouter un site web à Cloudflare
2. Changer les serveurs de noms de votre domaine vers Cloudflare

Installation de cloudflared

Les téléchargements sont disponibles sous forme de binaires autonomes, d'une image Docker, et de paquets Debian, RPM et Homebrew. Vous pouvez également trouver les versions ici sur le dépôt GitHub cloudflared.

• Vous pouvez installer sur macOS via Homebrew ou en téléchargeant la dernière version Darwin amd64
• Les binaires et les paquets Debian et RPM pour Linux sont disponibles ici
• Une image Docker de cloudflared est disponible sur DockerHub
• Vous pouvez installer sur des machines Windows en suivant les étapes ici
• Pour compiler depuis les sources, installez la version requise de go, mentionnée dans la section Développement ci-dessous. Vous pouvez ensuite exécuter make cloudflared.

La documentation utilisateur de Cloudflare Tunnel est disponible à l'adresse https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/

Création de Tunnels et routage du trafic

Une fois installé, vous pouvez authentifier cloudflared dans votre compte Cloudflare et commencer à créer des Tunnels pour servir le trafic vers vos origines.

• Créez un Tunnel en suivant ces instructions
• Acheminez le trafic vers ce Tunnel :
  • Via des enregistrements DNS publics dans Cloudflare
  • Ou via un nom d'hôte public guidé par un Cloudflare Load Balancer
  • Ou depuis le trafic privé du client WARP

TryCloudflare

Vous souhaitez tester Cloudflare Tunnel avant d'ajouter un site web à Cloudflare ? Vous pouvez le faire avec TryCloudflare en utilisant la documentation disponible ici.

Changements incompatibles

La suppression de flags CLI, de variables d'environnement, de clés de configuration ou de commandes constitue un changement incompatible. De telles suppressions doivent être annoncées dans le journal des modifications de Cloudflare Tunnel avant la version qui les supprime.

Versions obsolètes

Cloudflare prend actuellement en charge les versions de cloudflared qui sont à moins d'un an de la version la plus récente. Des changements incompatibles non liés à la disponibilité des fonctionnalités peuvent être introduits et impacter les versions publiées il y a plus d'un an. Vous pouvez en savoir plus sur la mise à niveau de cloudflared dans notre documentation développeur.

Par exemple, à compter de janvier 2023, Cloudflare prendra en charge cloudflared de la version 2023.1.1 à cloudflared 2022.1.1.

Développement

Prérequis

• GNU Make
• capnp
• go >= 1.27.4
• Outils optionnels :
  • capnpc-go
  • goimports
  • golangci-lint
  • gomocks

Mise à jour de Go

La directive go dans go.mod doit spécifier la version complète major.minor.patch (par exemple, go 1.27.4). N'omettez pas la version patch, y compris pour les versions .0. Il s'agit de la version exacte de Go utilisée pour compiler et tester cloudflared : le Makefile exporte GOTOOLCHAIN=go<version> à partir de celle-ci, de sorte que make télécharge cette chaîne d'outils chaque fois que le Go installé est plus ancien ou plus récent. Les outils que make exécute avec go run pkg@version utilisent également cette chaîne d'outils. Une directive toolchain dans go.mod est ignorée ; n'en ajoutez pas. Pour utiliser le Go installé à la place, exécutez make <target> GOTOOLCHAIN=local.

Lors de la mise à niveau de Go, mettez à jour la directive go et toutes les références de version correspondantes dans .gitlab-ci.yml, .ci/image/Dockerfile, .github/workflows/check.yaml et les Dockerfiles. Mettez à jour l'image du builder CI Linux et son digest dans .ci/linux.gitlab-ci.yml en conséquence ; son golangVersion sélectionne la famille d'images major/minor. Sur macOS et Windows, une inadéquation ne coûte qu'un téléchargement de chaîne d'outils. Les builds qui utilisent GOTOOLCHAIN=local échouent si leur Go est plus ancien que go.mod et utilisent leur propre Go s'il est plus récent.

Compilation

Pour compiler cloudflared localement, exécutez make cloudflared

Tests

Pour exécuter les tests localement, exécutez make test

Linting

Pour formater le code et maintenir une bonne qualité de code, utilisez make fmt et make lint

Mocks

Après des modifications sur les interfaces, vous devrez peut-être régénérer les mocks, exécutez donc make mocks