Habilitar suporte a proxy SOCKS5
Nesta página
Visão geral
Neste guia, você pode aprender como se conectar a instâncias MongoDB usando um proxy SOCKS5. SOCKS5 é um protocolo padronizado para conectar aos serviços de rede por meio de um servidor proxy.
Dica
Para saber mais sobre o5 protocolo SOCKS, consulte o verbete da Wikipedia sobre SOCKS.
Instalar o pacote de meias
A partir da versão 6.0 do driver Node.js, você deve instalar o pacote socks para utilizar o suporte de proxy SOCKS5 em seu aplicativo. Você pode instalar o socks executando o seguinte comando na sua shell:
npm i socks
Opções do cliente SOCKS5
Você pode configurar opções na sua instância do MongoClientOptions ou em seu URI de conexão para configurar o suporte de proxy SOCKS5 para sua conexão. A tabela a seguir descreve as opções do cliente relacionadas ao SOCKS5:
Nome | Valores aceitos | Valor padrão | Descrição |
|---|---|---|---|
proxyHost | string | null | Especifica o endereço IPv5 de proxy SOCKS4, endereço IPv6 ou nome de domínio. |
proxyPort | non-negative integer | null | Especifica o número da porta TCP do servidor proxy SOCKS5. Se você definir a opção proxyHost , o valor dessa opção será padronizado como 1080. |
proxyUsername | string | null | Especifica o nome de usuário para autenticação no servidor proxy SOCKS5. Se você definir essa opção como uma string de comprimento zero, o driver a ignorará. |
proxyPassword | string | null | Especifica a senha para autenticação no servidor proxy SOCKS5. Se você definir essa opção como uma string de comprimento zero, o driver a ignorará. |
Importante
O driver apresenta um erro se definir as opções proxyPort, proxyUsername ou proxyPassword sem definir a opção proxyHost.
Exemplo
Este exemplo mostra como instanciar um MongoClient que utiliza suporte de proxy SOCKS5. O código de exemplo a seguir especifica opções de servidor proxy e se conecta ao MongoDB:
// Replace the placeholder with your connection string const uri = "<connection string uri>"; // Replace the placeholders with your SOCKS5 proxy server details const socksOptions = { proxyHost: "<host>", proxyPort: 1080, proxyUsername: "<username>", proxyPassword: "<password>", }; // Create a new client with the proxy server details const client = new MongoClient(uri, socksOptions);
Dica
O código de amostra anterior usa placeholders para o URI de conexão e detalhes do servidor proxy. Para executar este código, você deve substituir estes placeholders pelas informações para seu sistema e servidor proxy.
Informações adicionais
Para obter mais informações sobre5 o suporte a proxy SOCKS , consulte a especificação SOCKS do MongoDB.5
Documentação da API
Para saber mais sobre os métodos e tipos discutidos neste guia, consulte a seguinte documentação da API: