Intégration de Cloudflare - Démarrage

Notre intégration à Cloudflare utilise la solution Edge Code de Cloudflare Cloudflare Workers pour vous fournir un service de salle d'attente qui fonctionne directement à partir de votre CDN sans que vous ayez à modifier le code de votre application ou vos serveurs web.

Introduction

Cet article vous guidera à travers les quatre étapes nécessaires à l'intégration de CrowdHandler avec Cloudflare.

• Étapes 1-2 vous guidera dans l'installation et la configuration de l'agent.
  • Créer un serveur Cloudflare.
  • Configurer les variables de l'opérateur.
• Étapes 3-4 démontrent comment activer la protection CrowdHandler sur les itinéraires choisis. 
  • Configurer les routes.
  • Exclure les itinéraires.
• Étape 5-6 fournit des références à des articles qui vous aideront à configurer vos salles d'attente via le panneau de contrôle CrowdHandler.  
  • Finalisez votre configuration.

Si, à un moment ou à un autre de la lecture du guide, vous êtes bloqué ou avez des questions, n'hésitez pas à nous contacter à l'adresse https://www.crowdhandler.com.

Conditions préalables

1. Un compte CrowdHandler actif. Si vous ne vous êtes pas encore inscrit, vous pouvez le faire ici.
2. Un compte Cloudflare.
3. The domain you intend to protect should be configured as "Proxied" in Cloudflare. DNS only mode will not work.

Protecting a WordPress or WooCommerce site? Make sure to set ORIGIN_TYPE = wordpress in Step 2 of the guide. 

Étape 1 : Créer un serveur Cloudflare.

1. Connectez-vous à votre compte Cloudflare.
2. Sélectionnez l'un de vos sites web :
   
3. Sélectionner Routes des travailleurs Menu de gauche Navigation
   
4. Il existe un bouton "Gérer les travailleurs" en haut à droite de la page, cliquez dessus et passez à l'étape suivante.

   
   

5. En haut à droite, cliquez sur le bouton "Créer une application"
   
   
   
6. Sur cette page, il y a un bouton au centre "Créer un travailleur"cliquez dessus et continuez.
   
    
7. Vous pouvez maintenant définir le nom de votre travailleur. crowdhandler-integration
   Note: Vous ne pouvez pas encore modifier le code. Il s'agit juste d'une configuration de base du travailleur.
   
   
   
8. Procédez à la création du travailleur en cliquant sur "Déployer"
   
   
   
9. Appliquons maintenant l'intégration du code en cliquant sur "Modifier le code"
   
10. Vous pouvez voir le code Hello World par défaut
    
    
11. Copier notre code d'intégration de GitHub et le coller dans le script.
    
    
    
12. Cliquez sur le bouton "Enregistrer et déployer".

Étape 2 : Configurer les variables du travailleur.

1. Appuyez sur le bouton retour de la page d'édition du script.
   
   
   
   
2. Naviguez vers Paramètres -> Variables.

• Ajoutez les variables suivantes puis cliquez sur enregistrer et déployer.
  1. API_ENDPOINT = https://api.crowdhandler.com/v1
  2. API_KEY = VOTRE_CLÉ_PUBLIQUE_ICI (Se trouve dans la section Compte -> API du panneau de contrôle de CrowdHandler).
  3. (Facultatif) WHITELABEL = faux (par défaut) vrai
  4. (Optional) ORIGIN_TYPE = wordpress (set this optional variable if you are protecting a WordPress or WooCommerce website)
  5. (Facultatif) NO_BYPASS = VOTRE_TOKEN_ALÉATOIRE_ICI
  6. (Facultatif) FAIL_TRUST = faux(par défaut) vrai
  7. (Facultatif) SAFETY_NET_SLUG = VOTRE_SLUG_DE_SALLE_D'ATTENTE_ICI

OPTIONAL VARIABLES

WHITELABEL (default false) By default, users will be queued on CrowdHandler's wait.crowdhandler.com domain. If WHITELABEL is set to true, users will be queued on the domain CrowdHandler is protecting. For example, if CrowdHandler has been set up to protect www.example.com, users will be queued on the www.example.com/ch/ path. The /ch/ route does not need to exist in your application. 
Read more about whitelabel waiting rooms here.

ORIGIN_TYPE Set value to wordpress if you are protecting a WordPress or WooCommerce origin. This will exclude URL requests matching the following regex pattern from CrowdHandler API checks.

/(wp-.*|wc-.*|xmlrpc\.php|readme\.html|license\.txt|trackback|feed(?:\/.*)?|comments\/feed(?:\/.*)?)(\?.*)?/

The NO_BYPASS value will be sent to your origin as the value of the x-ch-no-bypass header. You can check for this header in your application to verify that the request has traversed through CrowdHandler. Implementation examples can be found in the "Integration Examples" section of this article.

FAIL_TRUST (default true) By default, users that fail to check in with CrowdHandler's API will be trusted. If set to false, users that fail to check-in with CrowdHandler's API will be sent to a safety net waiting room until CrowdHandler is able to make a decision on what to do with them.
Read more about Trust on Fail here.

If SAFETY_NET_SLUG is defined and FAIL_TRUST is set to false, this waiting room slug will be used as the safety net room. If you do not define a SAFETY_NET_SLUG value and FAIL_TRUST is set to false, a generic waiting room template will be used as the safety net room. 

You can find your waiting room slug in the CrowdHandler control panel in the URL field of your room configuration.

Étape 3 : Configurer les routes protégées.

1. Dans la navigation de gauche, cliquez sur Sites Web, puis sur le domaine sur lequel vous intégrez CrowdHandler.
   
   
2. En utilisant à nouveau la navigation de gauche, sélectionnez Routes des travailleurs
   
   
3. Ajoutez l'itinéraire que vous souhaitez protéger.
   

Le schéma ci-dessus déclenchera le travailleur CrowdHandler pour tous les itinéraires de votre site, à l'exception des itinéraires exclus que vous configurerez à l'étape suivante. Nous vous recommandons de commencer par ce modèle à moins que vous ne soyez sûr que votre site ne sera pas inondé de trafic vers des routes non protégées.

Vous pouvez effectuer d'autres configurations plus granulaires des routes de la salle d'attente via la console d'administration de CrowdHandler.

Étape 4 : Exclure des itinéraires.

1. Exclure les routes qui ne doivent pas être protégées par CrowdHandler en ajoutant des routes supplémentaires en sélectionnant "Aucune" dans le menu déroulant du travailleur.

D'emblée, CrowdHandler n'essaiera pas de mettre en file d'attente les itinéraires avec les extensions de fichiers suivantes. 

"avi","css","csv","eot","gif","ico","jpg","js","json","map","mov","mp4","mpeg","mpg","ogg","ogv","ott","pdf","png","svg","ttf","webmanifest","wmv","woff","woff2","xml".

Il est de votre responsabilité d'omettre les motifs et les itinéraires qui ne doivent pas être mis en file d'attente. 

Voici quelques exemples courants :

* Les chemins utilisés pour stocker des actifs statiques et des médias, par exemple /wp-includes/*.
* Les URL de rappel créées par des fournisseurs de paiement tiers. 
* JSON et flux RSS.

Étape 5 : Finalisation de la configuration.

CrowdHandler est intégré à votre compte Cloudflare et c'est maintenant à vous de personnaliser votre configuration CrowdHandler à travers la console d'administration CrowdHandler. Voici quelques articles de support recommandés qui couvrent les bases :

1. Pour commencer (Vous pouvez ignorer les parties concernant l'installation de l'intégration Javascript).
2. Salles d'attente
3. Configuration du domaine

Étape 6 (recommandée) : Supprimer la limitation du débit des travailleurs de Cloudflare.

Au moment où nous écrivons ces lignes, le plan gratuit de Cloudflare workers est soumis à une limite de 1000 requêtes par minute et à une limite de 100 000 requêtes par jour. Si vous pensez que ces limites sont trop basses pour vous, nous vous recommandons de passer au plan payant Cloudflare workers pour supprimer ces limites.