Nginx代理WebSocket服务完整配置指南

概述

本文详细介绍如何使用Nginx代理运行在本地端口（如127.0.0.1:18789）的服务，特别是需要支持WebSocket连接的应用。我们将提供完整的Nginx配置示例，确保WebSocket连接和普通HTTP请求都能正常工作。

配置要点

Nginx代理WebSocket服务需要注意以下几个关键配置项：

1. 协议升级头：必须正确处理WebSocket的Upgrade请求
2. 长连接保持：WebSocket是持久连接，需要适当的时间设置
3. 缓冲控制：实时应用通常需要禁用某些缓冲

基础配置示例

以下是最简单的Nginx代理配置，包含WebSocket支持：

server {
    listen 80;
    # 可以使用您的服务器IP地址或域名
    server_name _; # 使用通配符接受所有主机头，或替换为您的IP/域名

    location / {
        proxy_pass http://127.0.0.1:18789;

        # WebSocket支持
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # 标准代理头
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # 超时设置
        proxy_read_timeout 300s;
        proxy_send_timeout 300s;
    }
}

完整配置示例

以下是一个功能更全面的Nginx配置，适用于生产环境：

server {
    listen 80;
    server_name your-domain.com; # 替换为您的域名

    # 如果您需要HTTPS，请取消注释以下行
    # listen 443 ssl;
    # ssl_certificate /path/to/your/certificate.crt;
    # ssl_certificate_key /path/to/your/private.key;

    # 设置客户端最大上传大小（根据需要调整）
    client_max_body_size 100M;

    # 处理WebSocket连接和其他请求
    location / {
        proxy_pass http://127.0.0.1:18789;

        # WebSocket支持
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # 标准代理头
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $server_name;

        # 超时设置
        proxy_connect_timeout 60s;
        proxy_send_timeout 60s;
        proxy_read_timeout 60s;

        # 缓冲设置
        proxy_buffering off;
        proxy_cache off;

        # 如果您的应用使用SSL后端
        proxy_redirect off;
    }

    # 如果您的应用有特定的WebSocket路径，可以单独配置
    location /ws {
        proxy_pass http://127.0.0.1:18789;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_read_timeout 86400;
    }
}

仅通过IP地址访问的配置

如果您希望通过IP地址直接访问服务，可以使用以下配置：

server {
    listen 80;
    # 替换为您的服务器实际IP地址
    server_name 127.0.0.1 192.168.x.x; # 根据实际情况替换

    client_max_body_size 100M;

    location / {
        proxy_pass http://127.0.0.1:18789;

        # WebSocket支持
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $server_name;

        proxy_connect_timeout 60s;
        proxy_send_timeout 60s;
        proxy_read_timeout 60s;

        proxy_buffering off;
        proxy_cache off;

        proxy_redirect off;
    }
}

配置说明

WebSocket支持指令

• proxy_http_version 1.1：设置HTTP版本为1.1，WebSocket协议需要此版本
• proxy_set_header Upgrade $http_upgrade：传递原始的Upgrade头部
• proxy_set_header Connection "upgrade"：设置连接类型为upgrade

超时设置

• proxy_read_timeout：设置从后端读取响应的超时时间，WebSocket连接需要较长的超时时间
• proxy_send_timeout：设置向后端发送请求的超时时间

缓冲设置

• proxy_buffering off：对于实时应用，关闭代理缓冲可以减少延迟

应用配置

将上述配置保存到Nginx站点配置目录：

sudo cp your-config-file.conf /etc/nginx/sites-available/
sudo ln -s /etc/nginx/sites-available/your-config-file /etc/nginx/sites-enabled/

测试配置语法：

sudo nginx -t

重新加载Nginx配置：

sudo systemctl reload nginx

故障排除

常见问题

1. WebSocket连接失败：检查Upgrade和Connection头是否正确设置
2. 连接断开过快：增加proxy_read_timeout值
3. SSL问题：如果前端使用HTTPS，确保后端也相应配置

验证配置

检查Nginx错误日志以排查问题：

sudo tail -f /var/log/nginx/error.log

总结

通过以上配置，您可以成功使用Nginx代理带有WebSocket功能的服务。记住关键是要正确处理WebSocket的协议升级请求，并设置适当的超时和缓冲选项。这种配置特别适用于需要通过公网访问本地运行服务的场景，同时也提供了负载均衡和安全防护的能力。

cnbugsai

打赏 海报 链接