How to implement Websockets proxy using Nginx Proxy Manager

How to use Nginx Proxy Manager to implement Websockets proxy

Websockets is a real-time communication protocol suitable for applications that require two-way communication. The Nginx Proxy Manager (NPM for short) is an Nginx-based proxy server that can be used to manage and configure multiple reverse proxy resources. This article will introduce how to use NPM to implement Websockets proxy and provide specific code examples.

1. Install NPM

First, we need to install NPM. On Ubuntu systems, you can install it with the following command:

sudo apt-get update
sudo apt-get install npm

2. Configure NPM

After installing NPM, we need to perform some configurations. First, enter the NPM installation directory, usually /usr/share/nginx/html, and then create a file named config.json to configure the proxy server.

In the config.json file, we can configure multiple proxy servers. In this example, we configure a proxy server named websocket to proxy all received Websockets requests to the specified target server.

The following is an example of configuration:

{
  "proxies": {
    "websocket": {
      "name": "Websockets Proxy",
      "ssl": false,
      "host": "ws://localhost:8000",
      "port": 80,
      "path": "/websocket",
      "proxyType": "websocket"
    }
  }
}

In the above configuration, we specify the name of the proxy server, whether to use SSL, the host and port of the target server, the URL path, and the proxy type.

3. Start NPM

After the configuration is completed, we can start NPM. Enter the NPM installation directory in the terminal, and then run the following command:

sudo npm start

At this time, NPM will listen on the default port 80 and start proxying requests.

4. Testing the Websockets proxy

Now that we have completed the configuration and startup of NPM, let's test whether our Websockets proxy is working properly.

First, prepare a simple Websockets server, which can be built using Node.js. Here is a sample code:

const WebSocket = require('ws');

const wss = new WebSocket.Server({ port: 8000 });

wss.on('connection', ws => {
  ws.on('message', message => {
    console.log(`Received message: ${message}`);
    ws.send(`Echo: ${message}`);
  });

  ws.send('Connected to server.');
});

Run the above code in the terminal to start the Websockets server.

Next, access the NPM management interface in the browser, usually http://localhost. On the interface, click the Add Proxy Host button and fill in the following information:

• Proxy Hostname: localhost
• Proxy Port: 80
• Proxy Protocol: http
• Proxy Type: websocket
• Proxy Destination: localhost:8000

Click the Save button to save the configuration.

Now, we can use any client that supports Websockets to connect to ws://localhost/websocket, send messages and receive responses from the server.

Through the NPM proxy server, we successfully implemented the proxy function of Websockets.

Summary

This article introduces how to use Nginx Proxy Manager to implement the proxy function of Websockets. By configuring NPM and using specific code examples, we successfully built a proxy server that can proxy Websockets requests. I hope this article will help you understand and use NPM and Websockets proxy.

The above is the detailed content of How to implement Websockets proxy using Nginx Proxy Manager. For more information, please follow other related articles on the PHP Chinese website!