Enable SOCKS5 Proxy Support启用SOCKS5代理支持

Overview概述

In this guide, you can learn how to connect to MongoDB instances by using a SOCKS5 proxy. SOCKS5 is a standardized protocol for connecting to network services through a proxy server.在本指南中，您可以学习如何使用SOCKS5代理连接到MongoDB实例。SOCKS5是用于通过代理服务器连接到网络服务的标准化协议。

Install the socks Package安装袜子包装

Starting in version 6.0 of the Node.js driver, you must install the socks package to use SOCKS5 proxy support in your application. You can install socks by running the following command in your shell:从Node.js驱动程序的6.0版本开始，您必须安装socks包才能在应用程序中使用SOCKS5代理支持。您可以通过在shell中运行以下命令来安装socks：

npm i socks

SOCKS5 Client OptionsSOCKS5客户端选项

You can set options in your MongoClientOptions instance or in your connection URI to configure SOCKS5 proxy support for your connection. The following table describes the client options related to SOCKS5:您可以在MongoClientOptions实例或连接URI中设置选项，为您的连接配置SOCKS5代理支持。下表描述了与SOCKS5相关的客户端选项：

Example示例

This example shows how to instantiate a MongoClient that uses SOCKS5 proxy support. The following example code specifies proxy server options and connects to MongoDB:此示例显示了如何实例化使用SOCKS5代理支持的MongoClient。以下示例代码指定了代理服务器选项并连接到MongoDB：

// Replace the placeholder with your connection string用连接字符串替换占位符
const uri = "<connection string uri>";

// Replace the placeholders with your SOCKS5 proxy server details用您的SOCKS5代理服务器详细信息替换占位符
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);

Additional Information附加信息

For more information about SOCKS5 proxy support, see the MongoDB SOCKS5 specification.有关SOCKS5代理支持的更多信息，请参阅MongoDB SOCKS5规范。