Compartilhar via

Usar o Proxy de Desenvolvimento em um contêiner Docker

Ao usar o Proxy de Desenvolvimento, você pode optar por executá-lo diretamente em seu computador ou em um contêiner do Docker. Executar o Proxy de Desenvolvimento no Docker é uma ótima maneira de isolá-lo do seu ambiente local. Ele também oferece uma maneira consistente de usar o Proxy de Desenvolvimento entre seu computador local e ambientes de CI/CD.

Usar a imagem do Docker do Proxy de Desenvolvimento

Para sua conveniência, fornecemos uma imagem do Docker pronta para uso com o Proxy de Desenvolvimento. Você pode usá-lo para executar o Proxy de Desenvolvimento em um contêiner do Docker. Você pode extrair a imagem do Registro de Contêiner do GitHub usando o seguinte comando:

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

Observação

Para experimentar os recursos de visualização mais recentes, use a versão beta do contêiner do Proxy Dev.

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

Se você usar o Proxy de Desenvolvimento em um pipeline de CI/CD, considere o uso de uma versão específica da imagem, em vez de latest ou beta. Dessa forma, você pode garantir que seu pipeline não seja afetado por mudanças disruptivas introduzidas na versão mais recente do Proxy de Desenvolvimento. Por exemplo, para usar o Proxy de Desenvolvimento versão 0.26.0, use o seguinte comando:

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

Iniciar o contêiner de Proxy de Desenvolvimento

Para iniciar o contêiner de Proxy de Desenvolvimento, use o seguinte comando:

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

Depois de executar o comando, o Proxy de Desenvolvimento é iniciado automaticamente e escuta o tráfego na porta 8000. Como ele está em execução em um contêiner do Docker, ele não se registra automaticamente como um proxy do sistema no host para interceptar solicitações da Web. Em vez disso, você precisa configurar manualmente o proxy do sistema em seu host ou configurar o proxy para seu aplicativo.

Executando o contêiner interativamente (usando as -it opções), você pode controlar o Proxy de Desenvolvimento na linha de comando. Interagir com o Proxy de Desenvolvimento é útil, por exemplo, para iniciar e parar a gravação, limpar a tela etc. Se você iniciar o contêiner em segundo plano, ainda poderá controlar o Proxy de Desenvolvimento usando a API de Proxy de Desenvolvimento.

Parâmetros

O Dev Proxy Docker contém vários parâmetros que você pode usar para customizar seu comportamento.

Portas

A imagem expõe as seguintes portas:

  • 8000 – a porta na qual o Proxy de Desenvolvimento escuta o tráfego de entrada.
  • 8897 – a porta na qual o Proxy de Desenvolvimento expõe sua API. Você pode usá-lo para interagir com o Dev Proxy programaticamente.

Importante

Lembre-se de mapear as duas portas para o host, de modo que você possa acessar o Proxy de Desenvolvimento no computador local e usar o Kit de Ferramentas do Proxy de Desenvolvimento.

Volumes

A imagem expõe os seguintes volumes:

  • /config - o diretório de trabalho atual do qual o contêiner inicia o Proxy de Desenvolvimento. Se a pasta mapeada contiver um devproxyrc.json arquivo, o Proxy de Desenvolvimento o usará automaticamente para se configurar.
  • /home/devproxy/.config/dev-proxy/rootCert - a pasta na qual o Proxy de Desenvolvimento armazena seu certificado raiz. Mapeando o volume para o host, você pode acessar com facilidade o certificado raiz e instalá-lo no sistema ou no navegador.

Dica

Como alternativa, para mapear o certificado raiz para o host, use a API do Proxy de Desenvolvimento para baixar a chave pública do certificado raiz no formato PEM (Privacy Enhanced Mail). Para baixar o certificado, chame o endpoint GET http://127.0.0.1:8897/proxy/rootCertificate?format=crt.

Usando o Proxy de Desenvolvimento no Docker

Quando você inicia o contêiner de Proxy de Desenvolvimento, ele inicia automaticamente o Proxy de Desenvolvimento escutando o tráfego de entrada na porta 8000.

Configuração padrão

O Dev Proxy procura o arquivo devproxyrc.json na pasta que você mapeia para o volume /config. Se ele encontrar o arquivo, ele o usará para se configurar. Se ele não encontrar o arquivo, ele usará a configuração padrão.

Configuração personalizada

Você pode usar a configuração personalizada do Proxy de Desenvolvimento criando o arquivo devproxyrc.json na pasta mapeada para o volume /config. Como alternativa, você pode especificar o arquivo de configuração usando o parâmetro --config-file ao iniciar o Proxy de Desenvolvimento. Por exemplo, para usar o myconfig.json arquivo, use o seguinte comando:

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

O arquivo de configuração especificado deve estar acessível no contêiner. Se você usar um caminho relativo, ele deverá ser relativo ao /config volume.

Outras opções

Se você quiser usar outras opções, poderá especificá-las da mesma maneira que faria ao executar o Proxy de Desenvolvimento diretamente em seu computador. Por exemplo, para especificar as URLs a serem vigiadas, use o seguinte comando:

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/*"
  • Last updated on