Partilhar via

Usar proxy de desenvolvimento em um contêiner do Docker

Ao usar o Dev Proxy, você pode optar por executá-lo diretamente em sua máquina ou em um contêiner do Docker. Executar o Dev Proxy no Docker é uma ótima maneira de isolá-lo do seu ambiente local. Ele também oferece uma maneira consistente de usar o Dev Proxy entre sua máquina 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 Dev Proxy. Você pode usá-lo para executar o Dev Proxy 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 Dev Proxy.

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

Se utilizar o Proxy Dev num pipeline de CI/CD, considere utilizar 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 quaisquer alterações significativas introduzidas na versão mais recente do Dev Proxy. Por exemplo, para usar o Dev Proxy versão 0.26.0, use o seguinte comando:

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

Inicie o contêiner Dev Proxy

Para iniciar o contêiner Dev Proxy, 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 Dev Proxy é iniciado automaticamente e escuta o tráfego na porta 8000. Como ele é executado em um contêiner do Docker, ele não se registra automaticamente como um proxy do sistema no host para intercetar 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 Dev Proxy a partir da linha de comando. Interagir com o Dev Proxy é ú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 personalizar seu comportamento.

Portos

A imagem expõe as seguintes portas:

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

Importante

Certifique-se de mapear ambas as portas para seu host, para que você possa acessar o Dev Proxy de sua máquina local e usar o Dev Proxy Toolkit.

Volumes

A imagem expõe os seguintes volumes:

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

Sugestão

Como alternativa ao mapeamento do certificado raiz para seu host, você pode usar a API Dev Proxy para baixar a chave pública do certificado raiz no formato PEM (Privacy Enhanced Mail). Para baixar o certificado, utilize o endpoint GET http://127.0.0.1:8897/proxy/rootCertificate?format=crt.

Usando o Dev Proxy no Docker

Ao iniciar o contentor Dev Proxy, este começa automaticamente a escutar o tráfego de entrada na porta 8000.

Configuração predefinida

O Dev Proxy procura o devproxyrc.json arquivo na pasta mapeada para o /config volume. Se encontrar o ficheiro, utiliza-o para se configurar. Se não encontrar o ficheiro, utiliza a configuração predefinida.

Configuração personalizada

Você pode usar uma configuração personalizada para o Dev Proxy criando o arquivo devproxyrc.json na pasta que você mapeia para o volume /config. Como alternativa, você pode especificar o arquivo de configuração usando o parâmetro ao iniciar o --config-file Dev Proxy. 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 a partir do contêiner. Se você usar um caminho relativo, ele deve ser relativo ao /config volume.

Outras opções

Se você quiser usar outras opções, você pode especificá-las da mesma maneira que faria ao executar o Dev Proxy diretamente em sua máquina. Por exemplo, para especificar as URLs a serem observadas, 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