Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.
All products
Codespaces do GitHub

Encaminhar portas no seu código

Neste artigo

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.

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. Abra o terminal no seu codespace.

  1. Clique na guia PORTAS.

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

    Captura de tela do botão "Adicionar porta".

  3. Digite o número ou o endereço da porta e pressione Enter.

    Captura de tela do número 3000 sendo inserido no campo Número da porta de uma nova porta encaminhada.

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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. Clique com o botão direito do mouse na porta que deseja atualizar e passe o cursor sobre Alterar Protocolo de Porta.

    Captura de tela do menu pop-up de uma porta encaminhada, com a opção "Alterar Protocolo da Porta" selecionada e "HTTPS" selecionado no submenu.

  4. 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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. Clique com o botão direito do mouse na porta que deseja compartilhar, selecione Visibilidade da Porta e clique em Privado para a Organização ou Público.

    Captura de tela do menu pop-up de uma porta encaminhada, com a opção "Visibilidade da Porta" selecionada e "Particular" selecionado no submenu.

  4. À direita do endereço local para a porta, clique no ícone copiar.

    Captura de tela do painel "Portas". O ícone de cópia, que copia a URL de uma porta encaminhada, é realçado com um contorno laranja.

  5. Envie a URL copiada para a pessoa com quem você deseja compartilhar a porta.

Como usar ferramentas de linha de comando e clientes REST para acessar portas

Quando você encaminha uma porta, seu aplicativo fica disponível em uma URL como https://USERNAME-CODESPACE-NAME-vrpqrxxrx7x2rxx-4000.preview.app.github.dev. Se você encaminhar uma porta privada do aplicativo da área de trabalho VS Code, seu aplicativo também ficará disponível em uma porta localhost, como 127.0.0.1:4000.

Para acessar seu aplicativo usando um cliente REST, como o Postman, ou uma ferramenta de linha de comando como curl, você não precisará se autenticar se estiver usando uma porta localhost ou se estiver acessando uma porta pública no domínio remoto. No entanto, para se conectar a uma porta privada no domínio remoto, você precisa se autenticar com o token de acesso GITHUB_TOKEN na sua solicitação.

Observação: o GITHUB_TOKEN é criado automaticamente quando você inicia um codespace e permanece igual durante a sessão de codespace. Se você interromper e reiniciar um codespace, um novo GITHUB_TOKEN será gerado.

### Como localizar o endereço ao qual se conectar

  1. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS. Ela lista todas as portas que você encaminhou.

  3. Clique com o botão direito do mouse na porta à qual você deseja se conectar e clique em Copiar Endereço Local.

    Captura de tela do menu pop-up de uma porta encaminhada com a opção "Copiar Endereço Local" realçada com um contorno laranja.

  4. Cole o endereço copiado em algum lugar para uso posterior.

Como localizar o GITHUB_TOKEN

  1. No terminal do seu codespace, insira echo $GITHUB_TOKEN.

    O token é uma cadeia de caracteres que começa com ghu_.

  2. Copie a o token.

    Importante: não compartilhe esse token de acesso com ninguém.

    ### Como usar o curl para acessar uma porta encaminhada

Em um terminal no computador local, insira:

curl ADDRESS -H "X-Github-Token: TOKEN"

Substitua ADDRESS e TOKEN pelos valores que você copiou anteriormente.

Como usar o Postman para acessar uma porta encaminhada

  1. Abra o Postman.

  2. Crie uma solicitação GET.

  3. Cole o endereço copiado anteriormente como a URL da solicitação.

    Captura de tela da URL da porta encaminhada, colada no Postman como a URL de solicitação GET. O URL é destacado.

  4. Na guia Cabeçalhos, crie uma entrada em que a chave é "X-Github-Token" e o valor é GITHUB_TOKEN que você copiou anteriormente.

    Captura de tela de um GITHUB_TOKEN fictício, colado no Postman como o valor da chave X-GitHub-Token. A chave e o valor estão realçados.

  5. Clique em Enviar. ## 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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta.

  4. Digite um rótulo para sua porta e pressione Enter.

    Captura de tela do rótulo "Preparo" adicionado como rótulo personalizado a uma porta encaminhada. ## 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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. 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.

    Captura de tela do menu pop-up de uma porta encaminhada, com a opção "Definir Rótulo e Atualizar devcontainer.json" realçada com um contorno laranja.

  4. Digite um rótulo para sua porta e pressione Enter.

    Captura de tela do rótulo "Preparo" adicionado como rótulo personalizado a uma porta encaminhada.

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.

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. Abra o terminal no seu codespace.

  1. Clique na guia PORTAS.

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

    Captura de tela do botão "Adicionar porta".

  3. Digite o número ou o endereço da porta e pressione Enter.

    Captura de tela do número 3000 sendo inserido no campo Número da porta de uma nova porta encaminhada.

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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. Clique com o botão direito do mouse na porta que deseja compartilhar, selecione Visibilidade da Porta e clique em Privado para a Organização ou Público.

    Captura de tela do menu pop-up de uma porta encaminhada, com a opção "Visibilidade da Porta" selecionada e "Particular" selecionado no submenu.

  4. À direita do endereço local para a porta, clique no ícone copiar.

    Captura de tela do painel "Portas". O ícone de cópia, que copia a URL de uma porta encaminhada, é realçado com um contorno laranja.

  5. Envie a URL copiada para a pessoa com quem você deseja compartilhar a porta.

Como usar ferramentas de linha de comando e clientes REST para acessar portas

Quando você encaminha uma porta, seu aplicativo fica disponível em uma URL como https://USERNAME-CODESPACE-NAME-vrpqrxxrx7x2rxx-4000.preview.app.github.dev. Se você encaminhar uma porta privada do aplicativo da área de trabalho VS Code, seu aplicativo também ficará disponível em uma porta localhost, como 127.0.0.1:4000.

Para acessar seu aplicativo usando um cliente REST, como o Postman, ou uma ferramenta de linha de comando como curl, você não precisará se autenticar se estiver usando uma porta localhost ou se estiver acessando uma porta pública no domínio remoto. No entanto, para se conectar a uma porta privada no domínio remoto, você precisa se autenticar com o token de acesso GITHUB_TOKEN na sua solicitação.

Observação: o GITHUB_TOKEN é criado automaticamente quando você inicia um codespace e permanece igual durante a sessão de codespace. Se você interromper e reiniciar um codespace, um novo GITHUB_TOKEN será gerado.

### Como localizar o endereço ao qual se conectar

  1. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS. Ela lista todas as portas que você encaminhou.

  3. Clique com o botão direito do mouse na porta à qual você deseja se conectar e clique em Copiar Endereço Local.

    Captura de tela do menu pop-up de uma porta encaminhada com a opção "Copiar Endereço Local" realçada com um contorno laranja.

  4. Cole o endereço copiado em algum lugar para uso posterior.

Como localizar o GITHUB_TOKEN

  1. No terminal do seu codespace, insira echo $GITHUB_TOKEN.

    O token é uma cadeia de caracteres que começa com ghu_.

  2. Copie a o token.

    Importante: não compartilhe esse token de acesso com ninguém.

    ### Como usar o curl para acessar uma porta encaminhada

Em um terminal no computador local, insira:

curl ADDRESS -H "X-Github-Token: TOKEN"

Substitua ADDRESS e TOKEN pelos valores que você copiou anteriormente.

Como usar o Postman para acessar uma porta encaminhada

  1. Abra o Postman.

  2. Crie uma solicitação GET.

  3. Cole o endereço copiado anteriormente como a URL da solicitação.

    Captura de tela da URL da porta encaminhada, colada no Postman como a URL de solicitação GET. O URL é destacado.

  4. Na guia Cabeçalhos, crie uma entrada em que a chave é "X-Github-Token" e o valor é GITHUB_TOKEN que você copiou anteriormente.

    Captura de tela de um GITHUB_TOKEN fictício, colado no Postman como o valor da chave X-GitHub-Token. A chave e o valor estão realçados.

  5. Clique em Enviar. ## 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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta.

  4. Digite um rótulo para sua porta e pressione Enter.

    Captura de tela do rótulo "Preparo" adicionado como rótulo personalizado a uma porta encaminhada. ## 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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. 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.

    Captura de tela do menu pop-up de uma porta encaminhada, com a opção "Definir Rótulo e Atualizar devcontainer.json" realçada com um contorno laranja.

  4. Digite um rótulo para sua porta e pressione Enter.

    Captura de tela do rótulo "Preparo" adicionado como rótulo personalizado a uma porta encaminhada.

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

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.

Como usar ferramentas de linha de comando e clientes REST para acessar portas

Quando você encaminha uma porta, seu aplicativo fica disponível em uma URL como https://USERNAME-CODESPACE-NAME-vrpqrxxrx7x2rxx-4000.preview.app.github.dev. Se você encaminhar uma porta privada do aplicativo da área de trabalho VS Code, seu aplicativo também ficará disponível em uma porta localhost, como 127.0.0.1:4000.

Para acessar seu aplicativo usando um cliente REST, como o Postman, ou uma ferramenta de linha de comando como curl, você não precisará se autenticar se estiver usando uma porta localhost ou se estiver acessando uma porta pública no domínio remoto. No entanto, para se conectar a uma porta privada no domínio remoto, você precisa se autenticar com o token de acesso GITHUB_TOKEN na sua solicitação.

Observação: o GITHUB_TOKEN é criado automaticamente quando você inicia um codespace e permanece igual durante a sessão de codespace. Se você interromper e reiniciar um codespace, um novo GITHUB_TOKEN será gerado.

Como localizar o endereço ao qual se conectar

Para localizar o endereço de uma porta encaminhada, insira gh codespace ports. Se você tiver mais de um codespace, selecione o codespace apropriado na lista exibida.

Copie o endereço e cole-o em algum lugar para uso posterior.

Como localizar o GITHUB_TOKEN

  1. Inicie uma sessão SSH para seu codespace.

    gh codespace ssh

  2. Se você tiver mais de um codespace, selecione o codespace apropriado na lista exibida.

  3. Exiba o GITHUB_TOKEN.

    echo $GITHUB_TOKEN

    O token é uma cadeia de caracteres que começa com ghu_.

  4. Copie a o token.

    Importante: não compartilhe esse token de acesso com ninguém.

  5. Saia da sessão do SSH.

    exit

Como usar o curl para acessar uma porta encaminhada

Em um terminal no computador local, insira:

curl ADDRESS -H "X-Github-Token: TOKEN"

Substitua ADDRESS e TOKEN pelos valores que você copiou anteriormente.

Como usar o Postman para acessar uma porta encaminhada

  1. Abra o Postman.

  2. Crie uma solicitação GET.

  3. Cole o endereço copiado anteriormente como a URL da solicitação.

    Captura de tela da URL da porta encaminhada, colada no Postman como a URL de solicitação GET. O URL é destacado.

  4. Na guia Cabeçalhos, crie uma entrada em que a chave é "X-Github-Token" e o valor é GITHUB_TOKEN que você copiou anteriormente.

    Captura de tela de um GITHUB_TOKEN fictício, colado no Postman como o valor da chave X-GitHub-Token. A chave e o valor estão realçados.

  5. Clique em Enviar. ## 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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. Passe o mouse sobre a porta que você deseja etiquetar, em seguida, clique no ícone da etiqueta.

  4. Digite um rótulo para sua porta e pressione Enter.

    Captura de tela do rótulo "Preparo" adicionado como rótulo personalizado a uma porta encaminhada.

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. Abra o terminal no seu codespace.

  2. Clique na guia PORTAS.

  3. 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.

    Captura de tela do menu pop-up de uma porta encaminhada, com a opção "Definir Rótulo e Atualizar devcontainer.json" realçada com um contorno laranja.

  4. Digite um rótulo para sua porta e pressione Enter.

    Captura de tela do rótulo "Preparo" adicionado como rótulo personalizado a uma porta encaminhada.

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.