> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/gateway/fr/getting-started/devolutions-gateway-configuration-on-linux.md). # Configuration de Devolutions Gateway sur Linux L'installation et l'exécution de Devolutions Gateway sur Linux sont rapides et faciles, à condition que plusieurs prérequis soient respectés. Ubuntu 22.04 LTS a été utilisé pour démontrer l'installation et la configuration. {% hint style="warning" %} Devolutions Server ou Devolutions Cloud est requis pour la configuration, ainsi qu'une licence Devolutions Gateway. {% endhint %} ### Installer Devolutions Gateway 1. Naviguez vers la page [Devolutions Gateway GitHub Release](https://github.com/Devolutions/devolutions-gateway/releases/) et téléchargez le fichier **.deb** de la dernière version. 2. Saisissez ce qui suit dans la ligne de commande : `wget https://github.com/Devolutions/devolutions-gateway/releases/download/v2024.3.2/devolutions-gateway_2024.3.2.0_amd64.deb` ![](https://cdnweb.devolutions.net/docs/DGW0027_2024_3.png) 3. Installez le paquet à l'aide de l'utilitaire `dpkg` : `sudo dpkg -i devolutions-gateway_2024.3.2.0_amd64.deb` ![](https://cdnweb.devolutions.net/docs/DGW0028_2024_3.png)

Les paquets de configuration et binaires se trouvent aux emplacements suivants :

### Mettre à jour Devolutions Gateway Pour mettre à jour Devolutions Gateway sur Linux, téléchargez le dernier paquet comme expliqué dans la section précédente et exécutez la commande d'installation. Le paquet s'installera par-dessus l'installation existante et préservera les configurations. ### Installer le module PowerShell gateway Il est recommandé d'utiliser le module PowerShell gateway pour configurer et gérer l'instance de Devolutions Gateway sur Linux. 1. Installez PowerShell avec cette commande : ```powershell source /etc/os-release wget -q https://packages.microsoft.com/config/ubuntu/$VERSION_ID/packages-microsoft-prod.deb sudo dpkg -i packages-microsoft-prod.deb rm packages-microsoft-prod.deb sudo apt-get update sudo apt-get install -y powershell ``` 2. Installez le module PowerShell de Devolutions Gateway : ```powershell Install-Module -Name DevolutionsGateway Import-Module -Name DevolutionsGateway ``` Une fois installé, la configuration de Devolutions Gateway peut être démarrée, arrêtée, consultée ou modifiée. ### Configurer les certificats Une confiance adéquate des certificats entre les systèmes est essentielle au bon fonctionnement de Devolutions Gateway. Des fonctionnalités telles que les WebSockets utilisés dans les vues du tableau de bord web de RDP, SSH, etc., nécessitent un certificat correctement approuvé. Un certificat provenant d'une autorité officielle telle que Let's Encrypt serait idéal pour la plupart des systèmes de production. Des certificats auto-signés, comme dans l'exemple présenté ci-dessous, peuvent être générés, mais nécessitent une configuration supplémentaire pour la confiance. Vous pouvez générer des certificats sur n'importe quel système et les utiliser dans Devolutions Gateway s'ils respectent les exigences relatives aux certificats. #### Générer un certificat LetsEncrypt sur Ubuntu 22.04 LTS via Certbot Une option consiste à générer un certificat LetsEncrypt avec l'utilitaire Certbot. Pour installer la dernière version, vous pouvez utiliser le gestionnaire de paquets snap. Selon la distribution Ubuntu, les dépôts APT par défaut peuvent ne pas contenir la dernière version du logiciel. Dans cet exemple, la vérification de domaine est utilisée avec Cloudflare comme fournisseur DNS. 1. L'exemple ci-dessous démontre l'exécution de Certbot installé et exécuté en tant qu'utilisateur racine, mais Devolutions Gateway en tant qu'utilisateur différent. ```shell sudo snap install certbot --classic sudo snap set certbot trust-plugin-with-root=ok sudo snap install certbot-dns-cloudflare ``` 2. Lorsque vous utilisez Cloudflare, générez un jeton d'API à portée utilisateur ou compte, en utilisant le modèle **Edit zone DNS**. Une fois que vous avez le jeton d'API, créez le dossier contenant et le fichier `.ini` correspondant pour contenir le jeton d'API. ```shell sudo install -d -m 0700 /root/.secrets sudo nano /root/.secrets/cloudflare.ini sudo chmod 0600 /root/.secrets/cloudflare.ini ``` 3. Demandez un certificat pour votre domaine Devolutions Gateway à l'aide du module d'extension DNS Cloudflare. Remplacez la valeur `gateway.mydomain.com` ci-dessous par votre propre domaine. ```shell certbot certonly --dns-cloudflare --dns-cloudflare-credentials /root/.secrets/cloudflare.ini -d gateway.mydomain.com --cert-name gateway ``` 4. Modifiez votre fichier de configuration `gateway.json` pour ajouter les lignes suivantes et utiliser le certificat nouvellement généré, à l'aide du module PowerShell de Devolutions Gateway. Les commandes ci-dessous modifient les variables de configuration `TlsCertificateFile`, `TlsPrivateKeyFile` et `Listeners`. ```powershell Import-Module DevolutionsGateway Set-DGatewayConfig -TlsCertificateFile "/etc/letsencrypt/live/gateway/fullchain.pem" -TlsPrivateKeyFile "/etc/letsencrypt/live/gateway/privkey.pem" -Listeners @( @{ "InternalUrl" = "tcp://*:8181" "ExternalUrl" = "tcp://*:8181" } @{ "InternalUrl" = "https://*:7171" "ExternalUrl" = "https://*:7171" } ) ``` 5. Avant de pouvoir redémarrer Devolutions Gateway pour utiliser le nouveau certificat, vous devez autoriser l'utilisateur qui exécute Devolutions Gateway à lire les fichiers de certificat. Ceci suppose que votre utilisateur se nomme **devolutions** et que le certificat se nomme **gateway**. Vous accordez des droits de traversée aux répertoires et des droits de lecture aux fichiers de certificat eux-mêmes. ```shell sudo setfacl -R -m u:devolutions:x /etc/letsencrypt/live sudo setfacl -R -m u:devolutions:x /etc/letsencrypt/live/gateway sudo setfacl -R -m u:devolutions:x /etc/letsencrypt/archive sudo setfacl -R -m u:devolutions:x /etc/letsencrypt/archive/gateway sudo setfacl -m u:devolutions:r /etc/letsencrypt/live/gateway/fullchain.pem sudo setfacl -m u:devolutions:r /etc/letsencrypt/live/gateway/privkey.pem sudo setfacl -m u:devolutions:r /etc/letsencrypt/archive/gateway/fullchain*.pem sudo setfacl -m u:devolutions:r /etc/letsencrypt/archive/gateway/privkey*.pem # Reconfigure to add a deploy hook sudo certbot reconfigure --cert-name gateway --deploy-hook "sudo setfacl -m u:devolutions:r /etc/letsencrypt/archive/gateway/fullchain*.pem; sudo setfacl -m u:devolutions:r /etc/letsencrypt/archive/gateway/privkey*.pem; systemctl restart devolutions-gateway.service" ``` 6. Redémarrez Devolutions Gateway à l'aide de la commande `systemctl` ou du module PowerShell de Devolutions Gateway. ```shell # Restart Gateway using systemctl systemctl restart devolutions-gateway.service ``` ```powershell # Restart Gateway using the Devolutions Gateway PowerShell module, assuming it is run in a pwsh shell. Import-Module DevolutionsGateway; Restart-DGateway ``` **Renouveler le certificat LetsEncrypt** Par défaut, avec la méthode d'installation Snap, une minuterie systemd est utilisée (au lieu d'une tâche cron), qui s'exécute deux fois par jour (bien qu'elle ne renouvelle un certificat que dans les 30 jours précédant son expiration). Pour forcer un renouvellement, vous pouvez utiliser la commande ci-dessous. ``` sudo certbot renew # To perform a renewal dry run and force a restart of the service, you can use the following command: # sudo certbot renew --dry-run --run-deploy-hooks ``` #### Générer un certificat auto-signé sur Ubuntu 22.04 LTS via OpenSSL À l'aide de l'utilitaire OpenSSL, générez un certificat directement à partir de la ligne de commande. Le certificat doit ensuite être placé directement dans le répertoire de configuration **/etc/devolutions-gateway**. ![](https://cdnweb.devolutions.net/docs/DGW0029_2024_3.png) ```powershell sudo openssl req -x509 -subj "/C=CA/ST=Quebec/L=Lavaltrie/O=Devolutions/CN=ubuntu-2204" -addext "subjectAltName = IP:10.10.0.20" -addext "extendedKeyUsage = serverAuth" -nodes -days 365 -newkey rsa:2048 -keyout /etc/devolutions-gateway/server.key -out /etc/devolutions-gateway/server.crt ``` La demande de certificat sera différente pour chaque configuration. Notez que le certificat **doit** inclure une extension **Subject Alternative Name (SAN)** avec soit un **nom DNS**, soit une **adresse IP**, et il devrait également contenir l'extension **Extended Key Usage (EKU)** avec l'objectif **Server Authentication** (`serverAuth`). Ceci est requis parce que les systèmes d'exploitation et les navigateurs modernes, y compris **Google Chrome** et **macOS,** rejetteront les certificats auxquels il manque un SAN ou l'EKU approprié, même si le nom commun (CN) est défini. Il est possible d'assouplir cette exigence en réglant l'option `TlsVerifyStrict` à `false` si nécessaire, mais ce n'est pas recommandé.
Options de personnalisationExplication
reqCréer et traiter des demandes de certificat, y compris des certificats auto-signés au format PKCS#10.
-x509Générer un certificat auto-signé.
-subj

Définir le sujet du certificat dans la ligne de commande. Il ne doit y avoir aucun espace entre les sections

  • /C - Pays en code à 2 chiffres, tel que « CA » pour le Canada ou « US » pour les États-Unis.
  • /ST - État ou province, tel que Québec ou Californie.
  • /L - Localité, telle que Lavaltrie ou Sacramento.
  • /O - Organisation, telle que Devolutions ou Microsoft.
  • /CN - Nom commun, ici ubuntu-2204 (tel qu'affiché via la commande hostname).
-addext

Pour ajouter un Subject Alternate Name (SAN), vous pouvez utiliser ce paramètre pour définir une entrée IP ou DNS.

  • "subjectAltName = IP:10.10.0.20"
  • "subjectAltName = DNS:ubuntu-2204"
-nodesNe pas chiffrer la clé privée créée.
-daysLe nombre de jours pendant lesquels le certificat est valide.
-newkeyDéfinir l'algorithme et la taille en bits, ici rsa:2048 est utilisé.
-keyoutL'emplacement où créer le fichier de clé privée.
-outL'emplacement où créer le fichier de clé publique.
#### Approuver le certificat auto-signé sur Ubuntu Le certificat TLS a deux objectifs : 1. Sécuriser l'API de gestion; 2. Sécuriser tout tunnel client-vers-Gateway dans lequel gateway peut inspecter ou filtrer le trafic (sites web, Gateway Tunnel, SCP/SFTP, etc.).\ Pour les protocoles opaques tels que RDP ou SSH, Devolutions Gateway transfère simplement des octets déjà chiffrés, mais le certificat demeure requis pour les vérifications d'état de gateway et les fonctionnalités futures. Une fois le certificat auto-signé créé, le certificat au sein du système Ubuntu devra être approuvé. Pour l'approuver à l'échelle du système, utilisez l'ensemble de commandes suivant : ```powershell cd /etc/devolutions-gateway sudo apt-get install -y ca-certificates sudo cp server.crt /usr/local/share/ca-certificates sudo update-ca-certificates ``` ![](https://cdnweb.devolutions.net/docs/DGW0030_2024_3.png) Le paquet `ca-certificates` peut déjà être installé. En exécutant la commande `update-ca-certificates`, un lien symbolique sera créé dans `/etc/ssl/certs` vers le fichier de certificat copié dans **/usr/local/share/ca-certificates**. ![](https://cdnweb.devolutions.net/docs/DGW0031_2024_3.png) {% hint style="warning" %} Si cela est fait dans Firefox, plusieurs erreurs de confiance apparaîtront, car le navigateur n'utilise pas le magasin de certificats à l'échelle du système. Leur [documentation](https://support.mozilla.org/en-US/kb/setting-certificate-authorities-firefox) propose quelques solutions à cela. {% endhint %} #### Approuver le certificat auto-signé sur Windows Après la création du certificat auto-signé, celui-ci devra être approuvé sur Devolutions Server. Les fichiers **server.crt** et **server.key** devront être transférés vers le système Windows; ou copiez et collez le contenu dans des fichiers (c.-à-d. **sudo cat server.crt** dans Ubuntu et copiez cela dans un fichier texte sur Windows). {% hint style="warning" %} Sautez cette section si Devolutions Server n'est pas exécuté sur Windows. {% endhint %} 1\. Copiez la clé publique vers Windows (dans l'exemple, **C:\Gateway** est un emplacement temporaire) :\ `sudo cat server.crt` ![](https://cdnweb.devolutions.net/docs/DGW0032_2024_3.png) 2. Copiez le contenu dans un fichier **server.crt**. ![](https://cdnweb.devolutions.net/docs/DGW0064_2024_3.png) 3. Copiez la clé privée vers Windows :\ `sudo cat server.key` ![](https://cdnweb.devolutions.net/docs/DGW0034_2024_3.png) 4. Copiez le contenu dans un fichier **server.key**. ![](https://cdnweb.devolutions.net/docs/DGW0065_2024_3.png) 5. Créez un fichier PFX à l'aide de l'outil de ligne de commande Windows certutil. Pour que cela fonctionne, le fichier de clé doit porter le même nom que le fichier **crt**, en ne différant que par l'extension :\ `certutil -mergepfx server.crt server.pfx` ![](https://cdnweb.devolutions.net/docs/DGW0036_2024_3.png) 6. Importez le fichier PFX dans le [magasin de certificats des autorités de certification racines de confiance](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/trusted-root-certification-authorities-certificate-store). 1. Double-cliquez sur le fichier **server.pfx** pour démarrer l'assistant d'importation et choisissez ***Ordinateur local***. 2. Cliquez sur ***Suivant*** et acceptez l'invite. ![](https://cdnweb.devolutions.net/docs/DGW0037_2024_3.png) 3. Cliquez sur ***Suivant***. ![](https://cdnweb.devolutions.net/docs/DGW0038_2024_3.png) 4. Entrez le mot de passe que vous avez saisi avec la commande `certutil`. * Optionnellement : choisissez ***Marquer cette clé comme exportable***. ![](https://cdnweb.devolutions.net/docs/DGW0039_2024_3.png) 5. Choisissez l'option ***Placer tous les certificats dans le magasin suivant***. 6. Sélectionnez ***Autorités de certification racines de confiance*** à l'aide du bouton ***Parcourir...***. 7. Cliquez sur ***Suivant***. ![](https://cdnweb.devolutions.net/docs/DGW0040_2024_3.png) 8. Cliquez sur ***Terminer*** pour compléter l'importation. ### Ouvrir les ports du pare-feu Ubuntu Si le système Linux utilise UFW (Uncomplicated Firewall) pour gérer le pare-feu basé sur iptables, exécutez les commandes suivantes pour ouvrir les ports nécessaires : ```powershell sudo ufw status sudo ufw allow 7171 sudo ufw allow 8181 sudo ufw status ``` ![](https://cdnweb.devolutions.net/docs/DGW0041_2024_3.png) ### Modifier la configuration de Devolutions Gateway La configuration par défaut d'un gateway contenue dans le fichier **/etc/devolutions-gateway/gateway.json** nécessite l'ajout des directives de certificat (l'`InternalUrl` devra utiliser HTTPS) : ```powershell { "Id": "YOUR-UNIQUE-GUID", "ProvisionerPublicKeyFile": "provisioner.pem", "ProvisionerPrivateKeyFile": null, "Listeners": [ { "InternalUrl": "tcp://:8181", "ExternalUrl": "tcp://:8181" }, { "InternalUrl": "http://:7171", "ExternalUrl": "https://:7171" } ] } ``` Modifiez le fichier ci-dessus pour refléter ce qui suit, en supposant que **server.crt** et **server.key** se trouvent dans le même répertoire que **gateway.json** (l'utilisation de l'éditeur de fichiers intégré Nano est recommandée) : ```powershell { "Id": "YOUR-UNIQUE-GUID", "ProvisionerPublicKeyFile": "provisioner.pem", "ProvisionerPrivateKeyFile": null, "TlsCertificateFile": "server.crt", "TlsPrivateKeyFile": "server.key", "Listeners": [ { "InternalUrl": "tcp://:8181", "ExternalUrl": "tcp://:8181" }, { "InternalUrl": "https://:7171", "ExternalUrl": "https://:7171" } ] } ``` ![](https://cdnweb.devolutions.net/docs/DGW0042_2024_3.png) #### Redémarrer Devolutions Gateway Une fois la nouvelle configuration en place, redémarrez Devolutions Gateway. Cela peut être fait avec la commande `systemctl` : ```powershell sudo systemctl restart devolutions-gateway.service sudo systemctl status devolutions-gateway.service ``` ![](https://cdnweb.devolutions.net/docs/DGW0046_2024_3.png) Alternativement, les commandes PowerShell `Stop-DGateway` et `Start-DGateway` peuvent également être utilisées. ### Connecter Devolutions Gateway à Devolutions Server #### Copier la clé publique de Devolutions Server vers Devolutions Gateway Linux 1. Connectez-vous à la console web de Devolutions Server et naviguez vers ***Administration***** – *****Devolutions Gateway***. 2. Cliquez sur le bouton ***Plus*** et choisissez l'option ***Télécharger la clé publique***. ![](https://cdnweb.devolutions.net/docs/DGW0049_2024_3.png) 3. Copiez le contenu du fichier **gateway\_public\_key.pem** téléchargé sur Windows. ![](https://cdnweb.devolutions.net/docs/DGW0066_2024_3.png) 4. Remplacez le contenu du fichier **/etc/devolutions-gateway/provisioner.pem** (l'utilitaire Nano est recommandé) par le contenu copié depuis Windows. ![](https://cdnweb.devolutions.net/docs/DGW0045_2024_3.png) 5. Redémarrez Devolutions Gateway avec la commande `sudo systemctl restart devolutions-gateway.service`. ![](https://cdnweb.devolutions.net/docs/DGW0046_2024_3.png) #### Configurer Devolutions Gateway dans Devolutions Server Allez dans l'interface Web de Devolutions Server où le Devolutions Gateway Linux nouvellement configuré sera ajouté. {% hint style="warning" %} Ignorez cette section si vous installez Devolutions Gateway avec Devolutions Cloud. {% endhint %} 1. Connectez-vous à la console Web de Devolutions Server et naviguez vers ***Administration*** – ***Devolutions Gateway***. 2. Cliquez sur le bouton ***Ajouter*** (***+***). 3. Sélectionnez ***Gateway***. ![](https://cdnweb.devolutions.net/docs/DGW0047_2024_3.png) 4. Entrez les informations suivantes (elles changeront selon la configuration). 1. ***Nom*** : Linux Gateway 2. ***URL de Devolutions Gateway*** : `https://10.10.0.20:7171` 3. ***Nom d'hôte TCP*** : `Ubuntu-2204` 5. Cliquez sur ***Enregistrer***. ![](https://cdnweb.devolutions.net/docs/DGW0050_2024_3.png)

Cliquez sur le menu d'options Plus du gateway et choisissez l'option Publier la liste de révocation si la liste de révocation est désuète.

![](https://cdnweb.devolutions.net/docs/DGW0048_2024_3.png) ### Résoudre les hôtes dans Ubuntu Le système Devolutions Gateway hébergé sur Linux doit être en mesure de résoudre les adresses demandées par Devolutions Server. La méthode de test la plus simple consiste à modifier le fichier hosts. Connectez-vous au système suivant : * **Nom d'hôte** : `it-help-dc` * **Nom de domaine complet (FQDN)** : `it-help-dc.ad.it-help.ninja` * **Adresse IP** : `10.10.0.3` Ouvrez le fichier hosts pour le modifier `sudo nano /etc/hosts` afin d'ajouter l'hôte dans Ubuntu. ![](https://cdnweb.devolutions.net/docs/DGW0052_2024_3.png) ### Ouvrir une session RDP Web Le gateway peut maintenant se connecter aux hôtes. Puisque l'hôte `it-help-dc` a été ajouté comme résoluble pour Ubuntu, il peut être utilisé pour se connecter dans une session Web. {% hint style="info" %} Les sessions Web nécessitent un gateway actif configuré pour l'entrée, et l'utilisateur qui lance la session devra avoir une licence Remote Desktop Manager édition Team ou une licence Devolutions Launcher qui lui est assignée. De plus, si des changements ont été apportés aux assignations de licences, il pourrait être nécessaire de se déconnecter et de se reconnecter pour voir l'option de lancer la connexion Web. {% endhint %} 1. Dans l'interface Web de Devolutions Server, cliquez sur ***Ajouter***. Sélectionnez une entrée de session ***RDP***. 2. Cliquez sur ***Continuer***. ![](https://cdnweb.devolutions.net/docs/DGW0053_2024_3.png) 3. Entrez un ***Nom*** et un ***Hôte*** qui doit être résoluble par l'installation Linux de Devolutions Gateway. 4. Cliquez sur ***Ajouter***. ![](https://cdnweb.devolutions.net/docs/DGW0054_2024_3.png) 5. Entrez ou liez tous les identifiants nécessaires à la session RDP et cliquez sur ***Ajouter***. ![](https://cdnweb.devolutions.net/docs/DGW0055_2024_3.png) 6. Sous l'onglet ***VPN/Tunnel/Gateway***, choisissez Devolutions Gateway comme type de VPN. 7. Réglez l'option ***Connecter*** à ***Toujours connecter***. 8. Choisissez le bon gateway. 9. Cliquez sur ***Ajouter***. ![](https://cdnweb.devolutions.net/docs/DGW0056_2024_3.png) 10. Cliquez sur ***Ouvrir dans le client Web***. ![](https://cdnweb.devolutions.net/docs/DGW0069_2024_3.png) ### Ouvrir une session RDP Remote Desktop Manager Si l'entrée est déjà configurée à partir de l'interface Web de Devolutions Server, elle peut être lancée depuis Remote Desktop Manager lorsque connecté à l'espace de travail Devolutions Server. {% hint style="warning" %} Ignorez cette section si vous installez Devolutions Gateway avec Devolutions Cloud. {% endhint %} Lors de la création d'une nouvelle entrée depuis Remote Desktop Manager, le processus est semblable à celui de Devolutions Server. 1. Dans Remote Desktop Manager, cliquez sur ***Nouvelle entrée***. Sélectionnez une entrée de session RDP. 2. Cliquez sur ***Sélectionner***. ![](https://cdnweb.devolutions.net/docs/DGW0058_2024_3.png) 3. Entrez un ***Nom*** et un ***Hôte*** qui doit être résoluble par l'installation Linux de Devolutions Gateway. 4. Entrez ou liez tous les identifiants nécessaires à la session RDP. ![](https://cdnweb.devolutions.net/docs/DGW0067_2024_3.png) 5. Réglez l'option ***Connecter*** à ***Toujours connecter***. 6. Sous l'onglet ***VPN/Tunnel/Gateway***, choisissez Devolutions Gateway comme type de VPN. ![](https://cdnweb.devolutions.net/docs/DGW0068_2024_3.png) 7. Allez au sous-onglet ***Paramètres (Devolutions Gateway)***. 8. Choisissez le Devolutions Gateway souhaité. 9. Cliquez sur ***Ajouter***. ![](https://cdnweb.devolutions.net/docs/DGW0061_2024_3.png) 10. Cliquez sur le bouton ***Ouvrir la session***.

En survolant la barre de titre, une infobulle apparaîtra et indiquera que la session RDP est connectée via Devolutions Gateway.

![](https://cdnweb.devolutions.net/docs/DGW0062_2024_3.png) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.devolutions.net/gateway/fr/getting-started/devolutions-gateway-configuration-on-linux.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.