How to configure nginx reverse proxy webSocket

Because the websocket protocol is upgraded based on the http protocol (see the figure below), you can use nginx reverse proxy websocket.

websocket

From As can be seen from this picture, the websocket connection is established based on the http protocol.

get /chat http/1.1
host: server.example.com
upgrade: websocket
connection: upgrade
sec-websocket-key: x3jjhmbdl1ezlkh9gbhxdw==
sec-websocket-protocol: chat, superchat
sec-websocket-version: 13
origin: http://example.com

Children who are familiar with http may have noticed that there are just a few more things in this handshake request similar to the http protocol.

upgrade: websocket
connection: upgrade
这个就是websocket的核心了，告诉apache、nginx等服务器：我发起的是websocket协议。
sec-websocket-key: x3jjhmbdl1ezlkh9gbhxdw==
sec-websocket-protocol: chat, superchat
sec-websocket-version: 13

First of all, sec-websocket-key is a base64 encode value, which is randomly generated by the browser. It tells the server: Peat, don’t fool me, I want to verify whether you are really a websocket assistant. .

Finally, sec-websocket-version tells the server the websocket draft (protocol version) used. At the beginning, the websocket protocol was still in the draft stage, and there were all kinds of weird protocols, and there were also There are many strange and different things. Firefox and Chrome use different versions. At the beginning, there were too many websocket protocols, which was a big problem. . But it’s okay now, it’s settled. A thing that everyone uses

Then the server will return the following things, indicating that the request has been accepted and the websocket has been successfully established!

http/1.1 101 switching protocols
upgrade: websocket
connection: upgrade
sec-websocket-accept: hsmrc0smlyukagmm5oppg2hagwk=
sec-websocket-protocol: chat

This is the last area that http is responsible for. Tell the client that I have successfully switched the protocol~

upgrade: websocket
connection: upgrade

is still fixed, telling the client that the upcoming upgrade is the websocket protocol. At this point, http has completed all its work, and the next step is to proceed completely in accordance with the websocket protocol.

Once you understand the principle of the protocol, you can proceed to the next step

First, nginx configures the https certificate

The server certificate is configured by the boss , I used it directly. Check it yourself if needed. 0.0

Add the following configuration to the service node in the nginx configuration file

location /wss
    {
         proxy_pass http://127.0.0.1:8888;
         proxy_http_version 1.1;
         proxy_set_header upgrade $http_upgrade;
         proxy_set_header connection "upgrade";
        proxy_set_header x-real-ip $remote_addr;
     }

Explain the parameters

/wss This is randomly set up. It tells nginx the URL to be proxied. Now my setting is wss. When I visit my server https:// abc.com/wss, nginx will map my request to the local port 8888.

proxy_pass The URL you want to proxy to, my proxy is to port 8888 of this machine.

proxy_http_version The http version used when proxying.

Here comes the key point:

Key parameters of proxy websocket

proxy_set_header upgrade Change the http request header when proxying upgrade Set to the request header of the original http request, and the request header of the wss protocol is websocket
proxy_set_header connection Because of the proxy wss protocol, the http request header is connection Set to upgrade

##proxy_set_header x-real-ip Set the ip of the original http request to the proxy and fill in $ remote_addr That's it

As for the response parameters of the websocket protocol, you don't need to worry about it during reverse proxy.

At this point, the configuration of nginx reverse proxy websocket is completed. Restart nginx, try to connect with websocket, and fill in the original wss address

wss://abc.com/wss. If the websocket is successfully connected, it means that the nginx reverse proxy websocket has been successful.

Summary

The current configuration is only the configuration when reverse proxying to this machine. If you want to reverse proxy to other hosts, the proxy may cross domains. The problem is that cross-domain configuration needs to be done in the reverse proxy of nginx.

Thinking

You can see this paragraph in the configuration file of nginx

location ~ .php$ {
   root html;
   fastcgi_pass 127.0.0.1:9000;
   fastcgi_index index.php;
   fastcgi_param script_filename $document_root$fastcgi_script_name;
   include fastcgi_params;
}

This is the configuration file of php in nginx, let me delete it, how? It looks so familiar, this configuration list is so similar to the websocket reverse proxy just now. I found out by searching the Internet that when nginx handles PHP type requests, it sends the request to the fastcgi management process. The fascgi management process selects the cgi sub-process processing result and returns it to nginx, and php-fpm is a PHP fastcgi manager. nginx itself cannot handle PHP. It is just a web server. When a request is received, if it is a PHP request, it is sent to the PHP interpreter for processing and the result is returned to the client. Therefore, when nginx handles PHP type requests, it is essentially implemented through the reverse proxy function.

We can expand our thinking and use nginx reverse proxy to achieve more functions, such as proxy tomcat

location /tomcat
    {
         proxy_pass http://127.0.0.1:8080;
         proxy_http_version 1.1;
        proxy_set_header x-real-ip $remote_addr;
     }

The above is the detailed content of How to configure nginx reverse proxy webSocket. For more information, please follow other related articles on the PHP Chinese website!