Encaminhar portas no seu código

Você pode encaminhar portas no seu código para testar e depurar seu aplicativo. You can also manage the port protocol and share the port within your organization or publicly.

Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. Para obter mais informações, consulte os "produtos do GitHub".

Sobre as portas encaminhadas

O redirecionamento de porta dá acesso a portas TCP que estão em execução no seu codespace. Por exemplo, se você estiver executando um aplicativo web em uma determinada porta no seu codespace, você pode encaminhar essa porta. Isso permite que você acesse o aplicativo do navegador na sua máquina local para testes e depuração.

Quando uma aplicação em execução dentro de um codespace imprime a saída para o terminal que contém uma URL do host local como http://localhost:PORT ou http://127.0.0.1:PORT, a porta é encaminhada automaticamente. Se você estiver usando Codespaces no navegador ou em Visual Studio Code, a string do URL no terminal é convertida em um link que você pode clicar para ver a página na sua máquina local. Por padrão, Codespaces encaminha portas usando HTTP.

Encaminhamento de porta automático

Você também pode encaminhar uma porta manualmente, etiquetar portas encaminhadas, compartilhar portas encaminhadas com integrantes da sua organização, compartilhar as portas encaminhadas publicamente e adicione as portas encaminhadas à configuração do codespace.

Encaminhar uma porta

Você pode encaminhar manualmente uma porta que não foi encaminhada automaticamente.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas

  2. Na lista de portas, clique em Adicionar porta.

    Botão adicionar porta

  3. Digite o número da porta ou endereço e, em seguida, pressione enter.

    Caixa de texto para o botão digitar porta

Usando encaminhamento de HTTPS

Por padrão, Codespaces encaminha portas usando HTTP, mas você pode atualizar qualquer porta para usar HTTPS, conforme necessário.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas
  2. Clique com o botão direito na porta que você deseja atualizar e, em seguida, passe o mouse sobre Alterar o Protocolo de Porta. Opção para mudar o protocolo de porta
  3. Selecione o protocolo necessário para esta porta. O protocolo que você selecionar será lembrado por esta porta durante o ciclo de vida do codespace.
  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas

  2. Na lista de portas, clique em Adicionar porta.

    Botão adicionar porta

  3. Digite o número da porta ou endereço e, em seguida, pressione enter.

    Caixa de texto para o botão digitar porta

Para saber mais sobre GitHub CLI, consulte "Sobre GitHub CLI."

Para encaminhar uma porta use o subcomando gh codespace ports forward. Substitua codespace-port:local-port pelas portas remotas e locais que você deseja conectar. Depois de entrar no comando, escolha entre a lista de codespaces exibidos.

gh codespace ports forward codespace-port:local-port 

Para obter mais informações sobre esse comando, consulte o manual deGitHub CLI.

Para ver os detalhes das portas encaminhadas, digite gh codespace ports e, em seguida, escolha um codespace.

Compartilhar uma porta

Observação: Você só pode tornar uma porta privada para uma organização se a sua organização usar GitHub Team ou GitHub Enterprise Cloud. Este recurso não está disponível atualmente na versão beta do Codespaces.

Se você quiser compartilhar uma porta encaminhada com outras pessoas, você pode tornar a porta privada da sua organização ou tornar a porta pública. Após tornar uma porta privada para a sua organização, qualquer pessoa na organização com a URL da porta poderá ver o aplicativo em execução. Após você tornar uma porta pública, qualquer pessoa que conheça a URL e o número da porta poderá ver o aplicativo em execução sem precisar efetuar a autenticação.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas
  2. Clique com o botão direito na porta que você deseja compartilhar, selecione o menu "Visibilidade da Porta" e, em seguida, clique em Privado para a Organização ou Público. Opção para selecionar a visibilidade da porta no menu do botão direito
  3. À direita do endereço local para a porta, clique no ícone copiar. Copiar ícone para o URL de porta
  4. Envie a URL copiada para a pessoa com quem você deseja compartilhar a porta.
  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas
  2. Clique com o botão direito na porta que você deseja compartilhar e clique em Tornar pública. Opção para tornar a porta pública no menu com o clique com o botão direito
  3. À direita do endereço local para a porta, clique no ícone copiar. Copiar ícone para o URL de porta
  4. Envie a URL copiada para a pessoa com quem você deseja compartilhar a porta.

Para alterar a visibilidade de uma porta encaminhada, use a visibilidade do subcomando gh codespace ports visibility. There are three visibility settings:

  • private - Visible only to you. This is the default setting when you forward a port.
  • org - Visible to members of the organization that owns the repository.
  • public - Visible to anyone who knows the URL and port number.

Substitua codespace-port pelo número da porta encaminhada. Substitua configuração por privado, org ou público. Depois de entrar no comando, escolha entre a lista de codespaces exibidos.

gh codespace ports visibility codespace-port:setting 

Você pode definir a visibilidade de várias portas com um comando. Por exemplo:

gh codespace ports visibility 80:private 3000:public 3306:org

Para obter mais informações sobre esse comando, consulte o manual deGitHub CLI.

Etiquetar uma porta

Você pode etiquetar uma porta para tornar a porta mais facilmente identificável em uma lista.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas
  2. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta. Ícone da etiqueta para a porta
  3. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto para digitar a etiqueta para porta

Adicionar uma porta à configuração do código

É possível adicionar uma porta encaminhada para a configuração Codespaces do repositório para que a porta seja automaticamente encaminhada para todos os códigos criados a partir do repositório. Depois de atualizar a configuração, todos os codespaces criados anteriormente deverão ser reconstruídos para que a alteração seja aplicada. Para obter mais informações, consulte "Configurar o Codespaces para seu projeto".

Você pode configurar manualmente as portas encaminhadas em um arquivo .devcontainer.json usando a propriedade forwardPorts ou você pode usar o painel "Portas" no seu codespace.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Aba Portas
  2. Clique com o botão direito na porta que você deseja adicionar à configuração do codespace e, em seguida, clique em Definir etiqueta e atualizar devcontainer.json. Opção para definir a etiqueta e adicionar a porta ao devcontainer.json no menu com o clique no botão direito
  3. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto para digitar a etiqueta para porta

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.