WebSocket proxying in Nginx - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is WebSocket proxying in nginx?

WebSocket proxying in nginx means forwarding WebSocket connections from clients to backend servers, allowing real-time communication through nginx as a middleman.

beginner

Which nginx directive is essential to support WebSocket proxying?

The directive proxy_set_header Upgrade $http_upgrade; is essential to handle the WebSocket handshake upgrade request properly.

intermediate

Why do we need to set proxy_http_version 1.1; for WebSocket proxying in nginx?

WebSocket requires HTTP/1.1 because it uses the Upgrade header to switch protocols. Setting proxy_http_version 1.1; ensures nginx uses the right HTTP version for the handshake.

intermediate

What headers must nginx forward to support WebSocket connections?

nginx must forward the Upgrade and Connection headers to allow the WebSocket handshake to succeed.

beginner

Show a minimal nginx configuration snippet to proxy WebSocket connections.

location /ws/ {
  proxy_pass http://backend_server;
  proxy_http_version 1.1;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection "upgrade";
}

Which HTTP version must nginx use to proxy WebSocket connections?

A HTTP/3

B HTTP/1.0

C HTTP/2

D HTTP/1.1

WebSocket handshake requires HTTP/1.1 because it uses the Upgrade header to switch protocols.

Which header tells the server to switch protocols to WebSocket?

A Upgrade

B Content-Type

C Authorization

D Cache-Control

The Upgrade header requests the server to change the protocol from HTTP to WebSocket.

What value should the Connection header have to support WebSocket proxying?

A keep-alive

B close

C upgrade

D proxy

The Connection header must be set to 'upgrade' to allow the protocol switch for WebSocket.

In nginx, which directive forwards the Upgrade header from client to backend?

A proxy_set_header Upgrade $http_upgrade;

B proxy_pass http://backend;

C proxy_redirect off;

D proxy_buffering off;

This directive forwards the Upgrade header needed for WebSocket handshake.

What happens if nginx does not forward the Upgrade and Connection headers for WebSocket?

A Connection will be faster

B WebSocket connection will fail

C No effect on WebSocket

D nginx will cache the connection

Without these headers, the WebSocket handshake cannot complete, so the connection fails.

Explain how to configure nginx to proxy WebSocket connections.

Think about the headers and HTTP version needed for WebSocket handshake.

Why is it important to set the Connection header to 'upgrade' in WebSocket proxying?

Consider what the Connection header controls in HTTP.

Practice

1. What is the main reason to use proxy_set_header Upgrade $http_upgrade; in nginx when proxying WebSocket connections?

easy

A. To tell nginx to allow the connection to switch protocols to WebSocket

B. To set the client's IP address in the header

C. To enable gzip compression for WebSocket data

D. To disable caching for WebSocket requests

Solution

1. Step 1: Understand the Upgrade header role

   The Upgrade header tells the server to switch from HTTP to another protocol, here WebSocket.

2. Step 2: Recognize nginx's proxy_set_header usage

   Setting proxy_set_header Upgrade $http_upgrade; passes the client's Upgrade header to the backend, enabling protocol switching.

3. Final Answer:

   To tell nginx to allow the connection to switch protocols to WebSocket -> Option A

4. Quick Check:

   Upgrade header enables protocol switch = A [OK]

Hint: Upgrade header signals WebSocket protocol switch [OK]

Common Mistakes:

• Confusing Upgrade with client IP headers
• Thinking it enables compression
• Assuming it disables caching

2. Which of the following nginx configuration snippets correctly enables WebSocket proxying?

easy

A. proxy_http_version 1.0; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade";

B. proxy_http_version 1.1; proxy_set_header Upgrade "websocket"; proxy_set_header Connection "close";

C. proxy_http_version 2.0; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "keep-alive";

D. proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade";

Solution

1. Step 1: Identify required HTTP version for WebSocket

   WebSocket proxying requires HTTP/1.1 because HTTP/1.0 does not support the Upgrade header properly.

2. Step 2: Check correct headers for WebSocket

   The Upgrade header must be passed as $http_upgrade and Connection header must be "upgrade" to maintain the protocol switch.

3. Final Answer:

   proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; -> Option D

4. Quick Check:

   HTTP/1.1 + Upgrade + Connection upgrade = B [OK]

Hint: Use HTTP/1.1 and set Upgrade and Connection headers correctly [OK]

Common Mistakes:

• Using HTTP/1.0 instead of 1.1
• Setting Connection to keep-alive or close
• Hardcoding Upgrade header instead of using $http_upgrade

3. Given this nginx config snippet inside a location block:

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_pass http://backend_server;

What will happen if a client tries to establish a WebSocket connection through nginx?

medium

A. The connection will be cached by nginx, causing stale data.

B. The WebSocket connection will be successfully proxied to the backend server.

C. The connection will be proxied but without protocol upgrade, causing failure.

D. The connection will fail because HTTP/2 is required for WebSocket.

Solution

1. Step 1: Analyze HTTP version and headers

   The config uses HTTP/1.1 and sets Upgrade and Connection headers correctly for WebSocket proxying.

2. Step 2: Understand nginx behavior with this config

   nginx will forward the WebSocket upgrade request to the backend, enabling a successful WebSocket connection.

3. Final Answer:

   The WebSocket connection will be successfully proxied to the backend server. -> Option B

4. Quick Check:

   Correct HTTP version and headers = successful proxy [OK]

Hint: HTTP/1.1 + Upgrade + Connection upgrade = success [OK]

Common Mistakes:

• Thinking HTTP/2 is required for WebSocket
• Assuming protocol upgrade is automatic without headers
• Believing nginx caches WebSocket connections

4. You have this nginx config for WebSocket proxying:

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "keep-alive";
proxy_pass http://backend;

Why might WebSocket connections fail with this setup?

medium

A. Because Connection header should be "upgrade" not "keep-alive" for WebSocket

B. Because proxy_http_version should be 1.0 for WebSocket

C. Because Upgrade header should be hardcoded to "websocket"

D. Because proxy_pass URL is missing a trailing slash

Solution

1. Step 1: Check Connection header value

   For WebSocket proxying, Connection header must be "upgrade" to signal protocol switch.

2. Step 2: Identify impact of incorrect Connection header

   Using "keep-alive" prevents the protocol upgrade, causing WebSocket connection failure.

3. Final Answer:

   Because Connection header should be "upgrade" not "keep-alive" for WebSocket -> Option A

4. Quick Check:

   Connection header must be upgrade for WebSocket [OK]

Hint: Connection header must be "upgrade" for WebSocket [OK]

Common Mistakes:

• Using keep-alive instead of upgrade
• Setting HTTP version to 1.0
• Hardcoding Upgrade header instead of using $http_upgrade

5. You want to proxy WebSocket connections through nginx to two backend servers for load balancing. Which configuration snippet correctly supports WebSocket proxying with load balancing?

hard

A. upstream ws_backend {
server backend1.example.com;
server backend2.example.com;
}
location /ws/ {
proxy_pass http://ws_backend;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "close";
}

B. upstream ws_backend {
server backend1.example.com;
server backend2.example.com;
}
location /ws/ {
proxy_pass http://ws_backend;
proxy_http_version 1.0;
proxy_set_header Upgrade websocket;
proxy_set_header Connection "keep-alive";
}

C. upstream ws_backend {
server backend1.example.com;
server backend2.example.com;
}
location /ws/ {
proxy_pass http://ws_backend;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}

D. upstream ws_backend {
server backend1.example.com;
server backend2.example.com;
}
location /ws/ {
proxy_pass http://ws_backend;
proxy_http_version 2.0;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
}

Solution

1. Step 1: Confirm HTTP version and headers for WebSocket

   HTTP/1.1 is required, and headers Upgrade and Connection must be set to allow protocol upgrade.

2. Step 2: Check load balancing setup and header correctness

   upstream ws_backend { server backend1.example.com; server backend2.example.com; } location /ws/ { proxy_pass http://ws_backend; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; } uses correct HTTP version, headers, and defines upstream servers for load balancing properly.

3. Final Answer:

   upstream ws_backend { server backend1.example.com; server backend2.example.com; } location /ws/ { proxy_pass http://ws_backend; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; } -> Option C

4. Quick Check:

   HTTP/1.1 + Upgrade + Connection upgrade + upstream = A [OK]

Hint: Use HTTP/1.1, Upgrade and Connection headers plus upstream for load balancing [OK]

Common Mistakes:

• Using HTTP/1.0 or 2.0 instead of 1.1
• Setting Connection to keep-alive or close
• Hardcoding Upgrade header instead of using $http_upgrade