如何在Nginx中正确覆盖已存在的location指令以避免重复报错

报错原因 #

Nginx 不允许同一个 server 块层级下存在两个完全相同的无修饰符前缀 location 规则，你原有配置中 /etc/nginx/available.d/application.conf 已经定义了 location /，后续在 custom.conf 中重复定义同规则就会抛出重复定义错误。

解决方案 #

根据你的场景可以选择以下两种方案： #

方案1：使用更高优先级的匹配规则覆盖原有location /的生效逻辑（无需重写整个server块）

利用Nginx的location匹配优先级规则：带^~修饰的前缀匹配 > 正则匹配 > 无修饰符的普通前缀匹配，两种写法按需选择：

• 如果不需要保留原有配置中其他正则location（比如PHP匹配、静态资源匹配）的逻辑，直接用^~修饰符，匹配所有以/开头的请求，优先级最高：

index app.php;
location ^~ / {
    try_files $uri $uri/ /app.php$is_args$query_string;
}

• 如果需要保留原有其他正则location的逻辑，用正则匹配覆盖普通前缀匹配的location /：

index app.php;
location ~ ^/ {
    try_files $uri $uri/ /app.php$is_args$query_string;
}

⚠️ 注意：该写法会覆盖原有所有无修饰符的前缀location规则（比如原有location /static这类配置会失效），如果你的原有配置有这类自定义前缀location，建议用方案2。 #

方案2：重写默认server块（全场景兼容，最稳妥）

利用Nginx的默认服务优先级规则，在custom.conf中定义一个标记为default_server的同端口server块，完全覆盖原有server块的所有配置，不会和原有配置的location规则冲突：

server {
    listen 80 default_server;
    root /var/www/html;
    index app.php;
    autoindex off;
    charset UTF-8;

    # 若需要保留原有application.conf里除location /之外的配置，请手动复制所需配置到此处，不要直接include避免重复引入location /报错
    location / {
        try_files $uri $uri/ /app.php$is_args$query_string;
    }
}

这个方案会让你新定义的server块成为80端口的默认处理服务，原有未带default_server标记的同端口server块不会再接收请求。

内容的提问来源于stack exchange，提问作者MagePsycho