Laravel Herd (Nginx) not handling clean URLs - all routes redirect to index.php

Laravel Herd (Nginx) not handling clean URLs - all routes redirect to index.php

I. Introduction

Laravel is a popular PHP framework that provides an elegant and expressive way to build web applications. Laravel uses its own web server, PHP-FPM, by default, but it can also be used with other web servers like Nginx or Apache. When using Nginx with Laravel, there are some common issues that developers may encounter, one of which is the inability to handle clean URLs. In this answer, we will discuss the causes and solutions for this issue.

II. Understanding the Problem

When using Laravel with Nginx, clean URLs are not handled by default. Instead, all routes are redirected to the index.php file. This can be a problem for developers who prefer clean URLs and want to maintain a more SEO-friendly URL structure.

III. Causes of the Problem

The issue of clean URLs not being handled in Laravel with Nginx is usually caused by incorrect configuration of the Nginx server block or the Laravel application itself. Here are some common causes:

1. Nginx server block configuration: The Nginx server block may not be configured correctly to handle Laravel's routing. Specifically, the try_files directive may not be set up correctly, or the index directive may be pointing to the wrong file.
2. Laravel application configuration: Laravel's .htaccess file or web.config file (for Windows) may be causing the issue. These files may be preventing Nginx from handling clean URLs correctly.
3. PHP-FPM configuration: PHP-FPM may not be configured correctly to work with Nginx and Laravel. Specifically, the fastcgi_pass directive in the Nginx server block may be pointing to the wrong PHP-FPM socket file.

IV. Solutions to the Problem

To solve the issue of clean URLs not being handled in Laravel with Nginx, follow these steps:

1. Configure the Nginx server block: Make sure that the Nginx server block is configured correctly to handle Laravel's routing. Here is an example of a correctly configured Nginx server block for Laravel:

server {
    listen 80;
    server_name example.com;

    root /var/www/laravel/public;

    index index.php index.html index.htm;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include fastcgi_params;
    }
}

Make sure that the root directive points to the public directory of your Laravel application, and that the try_files directive is set up correctly to try serving the requested file first, and then fallback to the index.php file if the file does not exist.

2. Remove Laravel's .htaccess file: Laravel's .htaccess file may be causing the issue. Remove the file or comment out any lines that may be preventing Nginx from handling clean URLs correctly.
3. Configure PHP-FPM: Make sure that PHP-FPM is configured correctly to work with Nginx and Laravel. Specifically, make sure that the fastcgi_pass directive in the Nginx server block is pointing to the correct PHP-FPM socket file.

V. Conclusion

In conclusion, the issue of clean URLs not being handled in Laravel with Nginx is usually caused by incorrect configuration of the Nginx server block, Laravel application, or PHP-FPM. By following the steps outlined in this answer, you should be able to resolve the issue and enjoy the benefits of clean URLs in your Laravel application.