Utiliser le proxy de développement dans un conteneur Docker

Lorsque vous utilisez le proxy de développement, vous pouvez choisir de l’exécuter directement sur votre ordinateur ou dans un conteneur Docker. L’exécution du proxy de développement dans Docker est un excellent moyen de l’isoler de votre environnement local. Il vous offre également un moyen cohérent d’utiliser le proxy de développement entre votre ordinateur local et les environnements CI/CD.

Utilisation de l’image Docker du proxy de développement

Pour votre commodité, nous fournissons une image Docker prête à être utilisée avec le proxy de développement. Vous pouvez l’utiliser pour exécuter le proxy de développement dans un conteneur Docker. Vous pouvez extraire l’image de GitHub Container Registry à l’aide de la commande suivante :

docker pull ghcr.io/dotnet/dev-proxy:latest

Remarque

Pour essayer les dernières fonctionnalités en préversion, utilisez la version bêta du conteneur de proxy de développement.

docker pull ghcr.io/dotnet/dev-proxy:beta

Si vous utilisez le proxy de développement dans un pipeline CI/CD, envisagez d’utiliser une version spécifique de l’image, au lieu de latest ou beta. De cette façon, vous pouvez vous assurer que votre pipeline n’est pas affecté par les modifications disruptives introduites dans la dernière version de Dev Proxy. Par exemple, pour utiliser Dev Proxy version 0.26.0, utilisez la commande suivante :

docker pull ghcr.io/dotnet/dev-proxy:0.26.0

Démarrer le conteneur du proxy de développement

Pour démarrer le conteneur proxy de développement, utilisez la commande suivante :

docker run \
    # remove the container when it exits
    --rm \
    # run the container interactively
    -it \
    # map Dev Proxy ports to the host
    -p 8000:8000 -p 8897:8897 \
    # map volumes to the host. Create the `cert` folder in the current working directory before running the command
    -v ${PWD}:/config -v ${PWD}/cert:/home/devproxy/.config/dev-proxy/rootCert \
    # specify the image to use
    ghcr.io/dotnet/dev-proxy:0.26.0

Après avoir exécuté la commande, le proxy de développement démarre automatiquement et écoute le trafic sur le port 8000. Étant donné qu’il s’exécute dans un conteneur Docker, il ne s’inscrit pas automatiquement en tant que proxy système sur l’hôte pour intercepter les requêtes web. Au lieu de cela, vous devez configurer manuellement le proxy système sur votre hôte ou configurer le proxy pour votre application.

En exécutant le conteneur de manière interactive (à l’aide des -it options), vous pouvez contrôler le proxy de développement à partir de la ligne de commande. L’interaction avec le proxy de développement est utile, par exemple, pour démarrer et arrêter l’enregistrement, effacer l’écran, etc. Si vous démarrez le conteneur en arrière-plan, vous pouvez toujours contrôler le proxy de développement à l’aide de l’API proxy de développement.

Paramètres

Le Docker du proxy de développement contient plusieurs paramètres que vous pouvez utiliser pour personnaliser son comportement.

Ports

L’image expose les ports suivants :

• 8000 : port sur lequel le proxy de développement écoute le trafic entrant.
• 8897 : port sur lequel le proxy de développement expose son API. Vous pouvez l’utiliser pour interagir avec Dev Proxy de manière programmatique.

Important

Veillez à mapper les deux ports à votre hôte pour pouvoir accéder au proxy de développement à partir de votre ordinateur local et utiliser dev Proxy Toolkit.

Volumes

L’image expose les volumes suivants :

• /config : répertoire de travail actuel à partir duquel le conteneur démarre le proxy de développement. Si le dossier que vous mappez contient un devproxyrc.json fichier, le proxy de développement l’utilise automatiquement pour se configurer lui-même.
• /home/devproxy/.config/dev-proxy/rootCert : dossier dans lequel le proxy de développement stocke son certificat racine. En mappant le volume à votre hôte, vous pouvez facilement accéder au certificat racine et l’installer dans votre système ou navigateur.

Conseil / Astuce

Une alternative au mappage du certificat racine à votre hôte est d'utiliser l'API Dev Proxy pour télécharger la clé publique du certificat racine au format PEM (Privacy Enhanced Mail). Pour télécharger le certificat, appelez le GET http://127.0.0.1:8897/proxy/rootCertificate?format=crt point de terminaison.

Utilisation du proxy de développement dans Docker

Lorsque vous démarrez le conteneur du proxy de développement, il démarre automatiquement le proxy de développement à l’écoute du trafic entrant sur le port 8000.

Configuration par défaut

Le proxy de développement recherche le devproxyrc.json fichier dans le dossier que vous mappez au /config volume. S’il trouve le fichier, il l’utilise pour le configurer lui-même. S’il ne trouve pas le fichier, il utilise la configuration par défaut.

Configuration personnalisée

Vous pouvez utiliser la configuration personnalisée pour le proxy de développement en créant le devproxyrc.json fichier dans le dossier que vous mappez au /config volume. Vous pouvez également spécifier le fichier de configuration à l’aide du paramètre --config-file lors du démarrage de Dev Proxy. Par exemple, pour utiliser le myconfig.json fichier, utilisez la commande suivante :

docker run \
    # remove the container when it exits
    --rm \
    # run the container interactively
    -it \
    # map Dev Proxy ports to the host
    -p 8000:8000 -p 8897:8897 \
    # map volumes to the host. Create the `cert` folder in the current working directory before running the command
    -v ${PWD}:/config -v ${PWD}/cert:/home/devproxy/.config/dev-proxy/rootCert \
    # specify the image to use
    ghcr.io/dotnet/dev-proxy:0.26.0 \
    # specify the configuration file to use
    --config-file /config/myconfig.json

Le fichier de configuration que vous spécifiez doit être accessible à partir du conteneur. Si vous utilisez un chemin relatif, il doit être relatif au /config volume.

Autres options

Si vous souhaitez utiliser d’autres options, vous pouvez les spécifier de la même façon que vous le feriez lors de l’exécution du proxy de développement directement sur votre ordinateur. Par exemple, pour spécifier les URL à surveiller, utilisez la commande suivante :

docker run \
    # remove the container when it exits
    --rm \
    # run the container interactively
    -it \
    # map Dev Proxy ports to the host
    -p 8000:8000 -p 8897:8897 \
    # map volumes to the host. Create the `cert` folder in the current working directory before running the command
    -v ${PWD}:/config -v ${PWD}/cert:/home/devproxy/.config/dev-proxy/rootCert \
    # specify the image to use
    ghcr.io/dotnet/dev-proxy:0.26.0 \
    # specify the URLs to watch
    --urls-to-watch "https://example.com/*"