Docs Menu
Docs Home
/
言語
/
JavaScript
/
Node.js ドライバー
/
Fundamentals
/
接続

SOCKS5 プロキシ サポートの有効化

項目一覧

  • Overview
  • socks パッケージをインストール
  • SOCKS5 クライアント オプション
  • 例
  • 詳細情報
  • API ドキュメント

Overview

このガイドでは、SOCKS5 プロキシを使用して MongoDB インスタンスに接続する方法を学習できます。 SOCKS5 は、プロキシ サーバーを介してネットワーク サービスに接続するための標準化プロトコルです。

Tip

SOCKS5 プロトコルの詳細については、 Wikipedia の SOCKS に関するエントリを参照してください。

socks パッケージをインストール

Node.js ドライバーのバージョン 6.0 以降では、アプリケーションで SOCKS5 プロキシ サポートを使用するには、 socksパッケージをインストールする必要があります。 socksをインストールするには、shell で次のコマンドを実行します。

npm i socks

SOCKS5 クライアント オプション

MongoClientOptionsインスタンスまたは接続 URI でオプションを設定して、接続の SOCKS5 プロキシ サポートを構成できます。 次の表では、SOCKS5 に関連するクライアント オプションについて説明します。

名前
許容値
デフォルト値
説明

proxyHost

string

null

SOCKS5 プロキシの IPv4 アドレス、IPv6 アドレス、またはドメイン名を指定します。

proxyPort

non-negative integer

null

SOCKS5 プロキシ サーバーの TCP ポート番号を指定します。proxyHost オプションを設定すると、このオプションの値はデフォルトで 1080 になります。

proxyUsername

string

null

SOCKS5 プロキシ サーバーへの認証に使用するユーザー名を指定します。このオプションを長さ 0 の文字列に設定すると、ドライバーはそれを無視します。

proxyPassword

string

null

SOCKS5 プロキシ サーバーへの認証用パスワードを指定します。このオプションを長さ 0 の文字列に設定すると、ドライバーはそれを無視します。

重要

proxyHostオプションを設定せずにproxyPort 、 proxyUsername 、またはproxyPasswordオプションを設定すると、ドライバーはエラーをスローします。

例

この例では、SOCKS5 プロキシ サポートを使用するMongoClientをインスタンス化する方法を示します。 次のサンプル コードでは、プロキシ サーバー オプションを指定し、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);

Tip

上記のサンプル コードでは、接続 URI とプロキシ サーバーの詳細にプレースホルダーを使用します。 このコードを実行するには、これらのプレースホルダーを配置とプロキシ サーバーの情報に置き換える必要があります。

詳細情報

SOCKS5 プロキシ サポートの詳細については、 MongoDB SOCKS5 仕様を参照してください。

API ドキュメント

このガイドで説明されているメソッドとタイプの詳細については、次の API ドキュメントを参照してください。

戻る

TLS

次へ

Stable API