ngrok

ngrok é um agente de linha de comando que conecta serviços locais ou privados à rede de nuvem do ngrok por meio de uma conexão criptografada de saída. Ele fornece endpoints públicos sem exigir alterações de firewall de entrada ou um endereço IP público na máquina de origem. Desenvolvedores o usam para pré-visualizações de aplicativos, testes de webhook, desenvolvimento de API e acesso controlado a serviços atrás de NAT ou firewalls.

Principais recursos

• Exponha serviços HTTP e HTTPS locais por meio de endpoints públicos e encaminhe o tráfego para uma porta upstream escolhida.
• Crie endpoints TCP ou TLS para casos de uso não HTTP compatíveis, sujeitos aos direitos da sua conta.
• Aplique Política de Tráfego para autenticar solicitações, rotear tráfego, reescrever solicitações ou limitar a taxa de acesso antes de chegar ao upstream.
• Inspecione o tráfego HTTP e reproduza solicitações capturadas para depurar webhooks e reproduzir falhas.
• Configure endpoints e o comportamento do agente em um arquivo de configuração, automatize comandos compatíveis ou execute o agente como um serviço do sistema operacional.
• Use uma única conexão TLS de saída na porta 443 para transportar o tráfego da rede do ngrok de volta à origem.

Instalação e primeiro uso

Instale brew install --cask ngrok. O pacote instala o executável ngrok e complementos de shell, não um aplicativo gráfico para Mac. Crie uma conta ngrok, obtenha seu próprio authtoken de agente e configure-o com ngrok config add-authtoken <YOUR_AUTHTOKEN>. Inicie seu aplicativo local e execute ngrok http 8080, substituindo 8080 pela porta de escuta dele. Use o endpoint exibido pelo agente. O endpoint criado por este agente existe enquanto a sessão do agente estiver em execução; um Endpoint na Nuvem separado tem comportamento de ciclo de vida diferente.

Requisitos, dependências e conflitos

O agente autônomo não tem dependência externa de runtime. O Homebrew não declara dependência de fórmula extra, conflitos explícitos de cask e nenhum mínimo explícito de versão do macOS neste snapshot. Ele fornece downloads nativos separados para Apple Silicon e Macs Intel. Esses metadados não estabelecem suporte para todas as versões históricas do macOS; consulte a página de download do fornecedor para builds compatíveis.

O fornecedor documenta 64 MB de memória mínima, 128 MB recomendados e aproximadamente 25 MB de disco; o uso real de recursos aumenta com tráfego simultâneo. Estas são orientações de runtime, não o tamanho do download compactado. Seu aplicativo upstream deve estar em execução e acessível pelo agente. Acesso à Internet e conectividade TLS de saída com o ngrok são necessários para endpoints na nuvem; proxy corporativo, firewall ou controles de conta podem afetar a conectividade.

Builds oficiais separadas do agente oferecem suporte a macOS x86-64/arm64, Windows x86-64/x86, Linux nas famílias x86, ARM, MIPS, PowerPC e s390x, e FreeBSD x86-64/x86/ARM. Baixe a build apropriada em vez de usar o ZIP do Mac em outro SO. SDKs do agente, contêineres e SSH reverso são escolhas de implantação separadas. As ferramentas usadas pelo serviço upstream mantêm seus próprios requisitos.

Contas, custos e licença

Usar o agente de nuvem ngrok exige uma conta e um authtoken de agente. Há um plano gratuito disponível com limites; planos pagos ou baseados em uso oferecem cotas e recursos diferentes. Domínios, opções de autenticação, protocolos de endpoint, retenção de tráfego e cobranças de uso dependem do plano atual. Baixar o binário não torna todo recurso do serviço ngrok gratuito ou ilimitado.

O agente atual e o serviço de nuvem são regidos pelos Termos de Serviço do ngrok. O agente distribuído moderno não é o antigo projeto ngrok v1 de código aberto. O repositório oficial da comunidade é usado para feedback e rastreamento de problemas; ele não é o código-fonte completo deste agente. SDKs de código aberto e outros componentes ngrok têm suas próprias licenças.

Referências: download para macOS, instalação e requisitos do agente, visão geral do agente, inspeção de tráfego, preços e termos.