Créez une distribution dont l’origine du comportement Default (*) est votre hôte actuel, ajoutez l’origine et les comportements Ferndesk ci-dessus, puis ajoutez votre domaine avec un certificat SSL d’AWS Certificate Manager dans la région US East (N. Virginia). Faites ensuite pointer votre domaine vers la distribution, par exemple à l’aide d’un enregistrement d’alias dans Route 53.
Placer votre centre d’aide dans un sous-dossier avec AWS CloudFront
Diffusez votre centre d’aide à un chemin de votre site hébergé derrière Amazon CloudFront, par exemple yourcompany.com/help, en ajoutant Ferndesk comme deuxième origine avec trois comportements de cache et une petite fonction CloudFront. Votre domaine doit déjà pointer vers la distribution CloudFront.
Un moyen de paiement doit être enregistré ; un essai avec une carte répond à cette exigence. Les propriétaires et les administrateurs peuvent modifier ce paramètre.
Configuration
Définir le sous-dossier dans Ferndesk
Dans Centre d’aide > Personnaliser > Domaine personnalisé, choisissez Sous-dossier personnalisé, saisissez le domaine de votre site et un chemin tel que /help, puis cliquez sur Configurer le sous-répertoire. Copiez l’Hôte proxy que nous vous indiquons (il ressemble à yourcompany.hc.ferndesk.com). Les exemples ci-dessous utilisent /help et www.yourcompany.com ; remplacez-les par vos propres valeurs.
Créer la fonction
Dans CloudFront > Functions, créez une fonction avec l’environnement d’exécution cloudfront-js-2.0, collez le code ci-dessous, puis publiez-la. Elle supprime /help du chemin avant que la requête n’atteigne Ferndesk. Si vous utilisez un autre chemin, modifiez help dans le code.
function handler(event) {
var request = event.request;
request.uri = request.uri.replace(/^\/help/, '') || '/';
return request;
}Ajouter Ferndesk comme origine
Dans l’onglet Origins de votre distribution, créez une origine dont le domaine d’origine est l’hôte proxy et dont le protocole est défini sur HTTPS uniquement. Ajoutez-y deux en-têtes personnalisés : X-Ferndesk-Base-Path défini sur votre chemin et X-Ferndesk-Original-Host défini sur l’hôte de votre site, par exemple www.yourcompany.com.
Ajouter trois comportements
Dans l’onglet Behaviors, créez un comportement pour chacun des chemins /help, /help/* et /_ferndesk/*, en les faisant tous pointer vers l’origine Ferndesk. Appliquez à chacun les paramètres suivants :
Règle de protocole du lecteur : Rediriger HTTP vers HTTPS
Méthodes HTTP autorisées : GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE
Stratégie de cache : CachingDisabled
Stratégie de requête à l’origine : AllViewerExceptHostHeader
Pour les comportements /help et /help/*, dans Function associations, associez la fonction comme fonction Viewer request. Ne l’associez pas à /_ferndesk/*. Votre site conserve le comportement Default (*). Attendez la fin du déploiement de la distribution.
Si vous gérez la distribution avec CloudFormation, les mêmes paramètres se présentent ainsi :
# The function (a separate resource in the same template)
FerndeskStripHelp:
Type: AWS::CloudFront::Function
Properties:
Name: ferndesk-strip-help
AutoPublish: true
FunctionConfig:
Comment: Remove /help before forwarding to Ferndesk
Runtime: cloudfront-js-2.0
FunctionCode: |
function handler(event) {
var request = event.request;
request.uri = request.uri.replace(/^\/help/, '') || '/';
return request;
}
# Part of DistributionConfig in the AWS::CloudFront::Distribution resource
Origins:
- Id: ferndesk
DomainName: PROXY_HOST
CustomOriginConfig:
OriginProtocolPolicy: https-only
OriginSSLProtocols: [TLSv1.2]
OriginCustomHeaders:
- HeaderName: X-Ferndesk-Base-Path
HeaderValue: /help
- HeaderName: X-Ferndesk-Original-Host
HeaderValue: www.yourcompany.com
# ...your site's existing origin stays here
CacheBehaviors:
- PathPattern: /help
TargetOriginId: ferndesk
ViewerProtocolPolicy: redirect-to-https
AllowedMethods: [GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE]
CachedMethods: [GET, HEAD]
CachePolicyId: 4135ea2d-6df8-44a3-9df3-4b5a84be39ad # CachingDisabled
OriginRequestPolicyId: b689b0a8-53d0-40ab-baf2-68738e2966ac # AllViewerExceptHostHeader
FunctionAssociations:
- EventType: viewer-request
FunctionARN: !GetAtt FerndeskStripHelp.FunctionMetadata.FunctionARN
- PathPattern: /help/*
TargetOriginId: ferndesk
ViewerProtocolPolicy: redirect-to-https
AllowedMethods: [GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE]
CachedMethods: [GET, HEAD]
CachePolicyId: 4135ea2d-6df8-44a3-9df3-4b5a84be39ad
OriginRequestPolicyId: b689b0a8-53d0-40ab-baf2-68738e2966ac
FunctionAssociations:
- EventType: viewer-request
FunctionARN: !GetAtt FerndeskStripHelp.FunctionMetadata.FunctionARN
- PathPattern: /_ferndesk/*
TargetOriginId: ferndesk
ViewerProtocolPolicy: redirect-to-https
AllowedMethods: [GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE]
CachedMethods: [GET, HEAD]
CachePolicyId: 4135ea2d-6df8-44a3-9df3-4b5a84be39ad
OriginRequestPolicyId: b689b0a8-53d0-40ab-baf2-68738e2966acRôle de chaque paramètre :
AllViewerExceptHostHeader transmet les cookies, les chaînes de requête et les en-têtes à Ferndesk, et envoie l’hôte proxy dans l’en-tête
Host. Si CloudFront transmet plutôt votre propre en-têteHost, toutes les pages renvoient une erreur 403 ou 502. Vous n’avez pas besoin d’envoyerX-Forwarded-Host: l’en-têteX-Ferndesk-Original-Hostremplit cette fonction.Toutes les méthodes HTTP sont nécessaires, car la connexion, les réponses de l’IA et le formulaire de commentaires envoient des requêtes
POSTsous/help.CachingDisabled préserve la confidentialité des pages consultées par les utilisateurs connectés. Ferndesk définit ses propres en-têtes de cache.
La fonction est nécessaire, car Ferndesk attend des chemins sans
/help. Sans elle, les articles se chargent, mais pas la connexion, les commentaires, les réponses de l’IA ni le plan du site.
Cette configuration suit la documentation AWS sur CloudFront. Nous ne l’avons pas testée nous-mêmes sur CloudFront. En cas de problème, écrivez à [email protected] en joignant votre configuration et l’adresse qui ne fonctionne pas.
Vérifier que tout fonctionne
Ouvrez https://www.yourcompany.com/help. Votre centre d’aide devrait s’afficher avec sa mise en forme, et les liens entre les articles devraient rester sur votre domaine. En cas de problème, consultez Dépanner votre centre d’aide.
Questions fréquentes
Mon site n’est pas encore hébergé derrière CloudFront
Puis-je plutôt utiliser un Application Load Balancer ?
Pas à lui seul. Un répartiteur de charge ne peut envoyer des requêtes qu’à vos propres serveurs, à des adresses IP privées ou à des fonctions Lambda, et non à un nom d’hôte public comme l’hôte proxy. Placez CloudFront devant lui ou exécutez Nginx sur vos serveurs et suivez le guide Nginx.
Le centre d’aide s’affiche sans mise en forme
Le comportement /_ferndesk/* est absent ou pointe vers l’origine de votre site. Il sert les scripts et les feuilles de style du centre d’aide depuis la racine de votre domaine.
Toutes les pages renvoient une erreur 403 ou 502
CloudFront transmet l’en-tête Host de votre site. Définissez la stratégie de requête à l’origine sur AllViewerExceptHostHeader pour les trois comportements, et non sur AllViewer.
Pour utiliser plutôt un sous-domaine ou d’autres hôtes, consultez Connecter un domaine personnalisé à votre centre d’aide.