Skip to main content

Encaminhar portas no seu código

Você pode encaminhar portas no seu código para testar e depurar seu aplicativo. Você também pode gerenciar o protocolo de porta e compartilhar a porta em sua organização ou de modo público.

Observação: o uso dos GitHub Codespaces com IDEs do JetBrains está em versão beta pública e sujeito a alterações no momento.

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 um aplicativo em execução em um codespace imprime a saída para o terminal que contém uma URL do localhost, como http://localhost:PORT ou http://127.0.0.1:PORT, a porta é encaminhada automaticamente. Se você estiver usando os GitHub Codespaces no navegador ou no Visual Studio Code, a cadeia de caracteres da URL no terminal será convertida em um link que acessa a página da Web no computador local. Por padrão, GitHub 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.

Observação: Os proprietários da organização podem restringir a capacidade de disponibilizar portas de encaminhamento publicamente ou dentro da organização. Para obter mais informações, confira "Como restringir a visibilidade das portas encaminhadas".

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". Guia Portas

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

    Botão adicionar porta

  2. 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, GitHub Codespaces encaminha portas usando HTTP, mas é possível atualizar qualquer porta para usar HTTPS, conforme necessário. Se uma porta com visibilidade pública for atualizada para usar HTTPS, a visibilidade dela mudará automaticamente para privada.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Guia Portas
  2. Clique com o botão direito do mouse na porta que deseja atualizar e posicione o cursor sobre Alterar Protocolo de Porta. Opção para alterar 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.

Compartilhar uma porta

Observação: você só poderá tornar uma porta privada para uma organização se a sua organização usar o GitHub Team ou o GitHub Enterprise Cloud.

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.

Observação: sua escolha de opções de visibilidade de porta pode ser limitada por uma política configurada para sua organização. Para obter mais informações, confira "Como restringir a visibilidade das portas encaminhadas".

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

Etiquetar uma porta

Ao abrir um codespace no navegador ou no aplicativo da área de trabalho VS Code, você pode rotular uma porta encaminhada para facilitar a identificação em uma lista.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Guia Portas
  2. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta. Ícone de rótulo para a porta 1. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto usada para digitar um rótulo para a porta ## Adicionar uma porta à configuração do código

É possível adicionar uma porta encaminhada à configuração dos GitHub Codespaces do repositório para que a porta seja encaminhada automaticamente a todos os codespaces criados 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, confira "Introdução aos contêineres de desenvolvimento".

Você pode configurar manualmente portas encaminhadas em um arquivo .devcontainer.json usando a propriedade forwardPorts, usar o painel "Portas" em um codespace aberto no navegador ou o aplicativo da área de trabalho VS Code.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Guia Portas
  2. Clique com o botão direito do mouse na porta que deseja adicionar à configuração do codespace e clique em Definir Rótulo e Atualizar devcontainer.json. Opção para definir rótulo e adicionar porta ao devcontainer.json no menu de atalho 1. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto usada para digitar um rótulo para a porta

Quando um aplicativo em execução em um codespace imprime a saída para o terminal que contém uma URL do localhost, como http://localhost:PORT ou http://127.0.0.1:PORT, a porta é encaminhada automaticamente. Se você estiver usando os GitHub Codespaces no navegador ou no Visual Studio Code, a cadeia de caracteres da URL no terminal será convertida em um link que acessa a página da Web no computador local. Por padrão, GitHub 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.

Observação: Os proprietários da organização podem restringir a capacidade de disponibilizar portas de encaminhamento publicamente ou dentro da organização. Para obter mais informações, confira "Como restringir a visibilidade das portas encaminhadas".

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". Guia Portas

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

    Botão adicionar porta

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

    Caixa de texto para o botão digitar porta

Compartilhar uma porta

Observação: você só poderá tornar uma porta privada para uma organização se a sua organização usar o GitHub Team ou o GitHub Enterprise Cloud.

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.

Observação: sua escolha de opções de visibilidade de porta pode ser limitada por uma política configurada para sua organização. Para obter mais informações, confira "Como restringir a visibilidade das portas encaminhadas".

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

Etiquetar uma porta

Ao abrir um codespace no navegador ou no aplicativo da área de trabalho VS Code, você pode rotular uma porta encaminhada para facilitar a identificação em uma lista.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Guia Portas
  2. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta. Ícone de rótulo para a porta 1. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto usada para digitar um rótulo para a porta ## Adicionar uma porta à configuração do código

É possível adicionar uma porta encaminhada à configuração dos GitHub Codespaces do repositório para que a porta seja encaminhada automaticamente a todos os codespaces criados 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, confira "Introdução aos contêineres de desenvolvimento".

Você pode configurar manualmente portas encaminhadas em um arquivo .devcontainer.json usando a propriedade forwardPorts, usar o painel "Portas" em um codespace aberto no navegador ou o aplicativo da área de trabalho VS Code.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Guia Portas
  2. Clique com o botão direito do mouse na porta que deseja adicionar à configuração do codespace e clique em Definir Rótulo e Atualizar devcontainer.json. Opção para definir rótulo e adicionar porta ao devcontainer.json no menu de atalho 1. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto usada para digitar um rótulo para a porta

Para saber mais sobre a GitHub CLI, confira "Sobre a GitHub CLI".

Para encaminhar uma porta, use o subcomando gh codespace ports forward. Substitua codespace-port:local-port pelas portas remotas e locais que 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, confira o manual da GitHub CLI.

Para ver os detalhes das portas encaminhadas, insira gh codespace ports e escolha um codespace.

Compartilhar uma porta

Observação: você só poderá tornar uma porta privada para uma organização se a sua organização usar o GitHub Team ou o GitHub Enterprise Cloud.

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.

Observação: sua escolha de opções de visibilidade de porta pode ser limitada por uma política configurada para sua organização. Para obter mais informações, confira "Como restringir a visibilidade das portas encaminhadas".

Para alterar a visibilidade de uma porta encaminhada, use o subcomando gh codespace ports visibility. Há três configurações de visibilidade:

  • private – Visível somente para você. Essa é a configuração padrão quando você encaminha uma porta.
  • org – Visível para os membros da organização que é o proprietário do repositório.
  • public – Visível para qualquer pessoa que conheça a URL e o número da porta.

Substitua codespace-port pelo número da porta encaminhada. Substitua setting por private, org ou public. Depois de entrar no comando, escolha entre a lista de codespaces exibidos.

gh codespace ports visibility CODESPACE-PORT:SETTINGS

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, confira o manual da GitHub CLI.

Etiquetar uma porta

Ao abrir um codespace no navegador ou no aplicativo da área de trabalho VS Code, você pode rotular uma porta encaminhada para facilitar a identificação em uma lista.

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

Você pode ver os rótulos de porta ao listar as portas encaminhadas para um codespace. Para fazer isso, use o comando gh codespace ports e selecione um codespace.

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

É possível adicionar uma porta encaminhada à configuração dos GitHub Codespaces do repositório para que a porta seja encaminhada automaticamente a todos os codespaces criados 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, confira "Introdução aos contêineres de desenvolvimento".

Você pode configurar manualmente portas encaminhadas em um arquivo .devcontainer.json usando a propriedade forwardPorts, usar o painel "Portas" em um codespace aberto no navegador ou o aplicativo da área de trabalho VS Code.

  1. No seu codespace, embaixo do editor de texto, clique em "Portas". Guia Portas
  2. Clique com o botão direito do mouse na porta que deseja adicionar à configuração do codespace e clique em Definir Rótulo e Atualizar devcontainer.json. Opção para definir rótulo e adicionar porta ao devcontainer.json no menu de atalho 1. Digite uma etiqueta para a sua porta e pressione enter. Caixa de texto usada para digitar um rótulo para a porta

Encaminhar uma porta

Para obter informações sobre como encaminhar uma porta em um codespace para uma porta em seu computador local, consulte a seção "Encaminhamento de porta" do artigo "Modelo de segurança" na documentação do JetBrains.

Como alternativa, você pode usar GitHub CLI para encaminhar uma porta. Para obter mais informações, clique na guia "GitHub CLI" na parte superior desta página.