Merge pull request #2670 from jreklund/nginx-documentation

Added default configuration for Nginx in "Running Your App" [ci-skip]

Author: MGatner

user_guide_src/source/general/urls.rst

@@ -62,7 +62,7 @@ the above Apache configuration:
 .. code-block:: nginx
 
 	location / {
-		try_files $uri $uri/ /index.php/$args;
+		try_files $uri $uri/ /index.php$is_args$args;
 	}
 
 This will first look for a file or directory matching the URI (constructing the full path to each file from the

user_guide_src/source/installation/running.rst

@@ -5,8 +5,8 @@ Running Your App
     :local:
     :depth: 1
 
-A CodeIgniter 4 app can be run in a number of different ways: hosted on a web server, 
-using virtualization, or using CodeIgniter’s command line tool for testing. 
+A CodeIgniter 4 app can be run in a number of different ways: hosted on a web server,
+using virtualization, or using CodeIgniter’s command line tool for testing.
 This section addresses how to use each technique, and explains some of the pros and cons of them.
 
 If you’re new to CodeIgniter, please read the :doc:`Getting Started </intro/index>`
@@ -72,24 +72,24 @@ The local development server can be customized with three command line options:
 Hosting with Apache
 =================================================
 
-A CodeIgniter4 webapp is normally hosted on a web server. 
+A CodeIgniter4 webapp is normally hosted on a web server.
 Apache’s ``httpd`` is the "standard" platform, and assumed in much of our documentation.
 
-Apache is bundled with many platforms, but can also be downloaded in a bundle 
-with a database engine and PHP from [Bitnami](https://bitnami.com/stacks/infrastructure).
+Apache is bundled with many platforms, but can also be downloaded in a bundle
+with a database engine and PHP from `Bitnami <https://bitnami.com/stacks/infrastructure>`_.
 
 .htaccess
 -------------------------------------------------------
 
-The “mod_rewrite” module enables URLs without “index.php” in them, and is assumed 
+The “mod_rewrite” module enables URLs without “index.php” in them, and is assumed
 in our user guide.
 
-Make sure that the rewrite module is enabled (uncommented) in the main 
+Make sure that the rewrite module is enabled (uncommented) in the main
 configuration file, eg. ``apache2/conf/httpd.conf``::
 
     LoadModule rewrite_module modules/mod_rewrite.so
 
-Also make sure that the default document root's <Directory> element enables this too, 
+Also make sure that the default document root's <Directory> element enables this too,
 in the "AllowOverride" setting::
 
     <Directory "/opt/lamp7.2/apache2/htdocs">
@@ -101,21 +101,21 @@ in the "AllowOverride" setting::
 Virtual Hosting
 -------------------------------------------------------
 
-We recommend using “virtual hosting” to run your apps. 
+We recommend using “virtual hosting” to run your apps.
 You can set up different aliases for each of the apps you work on,
 
-Make sure that the virtual hosting module is enabled (uncommented) in the main 
+Make sure that the virtual hosting module is enabled (uncommented) in the main
 configuration file, eg. ``apache2/conf/httpd.conf``::
 
     LoadModule vhost_alias_module modules/mod_vhost_alias.so
 
-Add a host alias in your “hosts” file, typically ``/etc/hosts`` on unix-type platforms, 
-or ``c:/Windows/System32/drivers/etc/hosts`` on Windows. 
+Add a host alias in your “hosts” file, typically ``/etc/hosts`` on unix-type platforms,
+or ``c:/Windows/System32/drivers/etc/hosts`` on Windows.
 Add a line to the file. This could be "myproject.local" or "myproject.test", for instance::
 
     127.0.0.1 myproject.local
 
-Add a <VirtualHost> element for your webapp inside the virtual hosting configuration, 
+Add a <VirtualHost> element for your webapp inside the virtual hosting configuration,
 eg. ``apache2/conf/extra/httpd-vhost.conf``::
 
     <VirtualHost *:80>
@@ -125,7 +125,7 @@ eg. ``apache2/conf/extra/httpd-vhost.conf``::
         CustomLog "logs/myproject-access_log" common
     </VirtualHost>
 
-If your project folder is not a subfolder of the Apache document root, then your 
+If your project folder is not a subfolder of the Apache document root, then your
 <VirtualHost> element may need a nested <Directory> element to grant the web s
 erver access to the files.
 
@@ -136,12 +136,51 @@ With the above configuration, your webapp would be accessed with the URL ``http:
 
 Apache needs to be restarted whenever you change its configuration.
 
+Hosting with Nginx
+=================================================
+Nginx is the second most widely used HTTP server for web hosting.
+Here you can find an example configuration using PHP 7.3 FPM (unix sockets) under Ubuntu Server.
+
+This configuration enables URLs without “index.php” in them and using CodeIgniter's “404 - File Not Found” for URLs ending with “.php”.
+
+.. code-block:: nginx
+
+    server {
+        listen 80;
+        listen [::]:80;
+
+        server_name example.com;
+
+        root  /var/www/example.com/public;
+        index index.php index.html index.htm;
+
+        location / {
+            try_files $uri $uri/ /index.php$is_args$args;
+        }
+
+        location ~ \.php$ {
+            include snippets/fastcgi-php.conf;
+
+            # With php-fpm:
+            fastcgi_pass unix:/run/php/php7.3-fpm.sock;
+            # With php-cgi:
+            # fastcgi_pass 127.0.0.1:9000;
+        }
+
+        error_page 404 /index.php;
+
+        # deny access to hidden files such as .htaccess
+        location ~ /\. {
+            deny all;
+        }
+    }
+
 Hosting with Vagrant
 =================================================
 
-Virtualization is an effective way to test your webapp in the environment you 
-plan to deploy on, even if you develop on a different one. 
-Even if you are using the same platform for both, virtualization provides an 
+Virtualization is an effective way to test your webapp in the environment you
+plan to deploy on, even if you develop on a different one.
+Even if you are using the same platform for both, virtualization provides an
 isolated environment for testing.
 
 The codebase comes with a ``VagrantFile.dist``, that can be copied to ``VagrantFile``
@@ -150,11 +189,11 @@ and tailored for your system, for instance enabling access to specific database
 Setting Up
 -------------------------------------------------------
 
-It assumes that you have installed `VirtualBox <https://www.virtualbox.org/wiki/Downloads>`_ and 
-`Vagrant <https://www.vagrantup.com/downloads.html>`_ 
+It assumes that you have installed `VirtualBox <https://www.virtualbox.org/wiki/Downloads>`_ and
+`Vagrant <https://www.vagrantup.com/downloads.html>`_
 for your platform.
 
-The Vagrant configuration file assumes you have set up a `ubuntu/bionic64 Vagrant box 
+The Vagrant configuration file assumes you have set up a `ubuntu/bionic64 Vagrant box
 <https://app.vagrantup.com/ubuntu/boxes/bionic64>`_ on your system::
 
     vagrant box add ubuntu/bionic64
@@ -166,6 +205,6 @@ Once set up, you can then launch your webapp inside a VM, with the command::
 
     vagrant up
 
-Your webapp will be accessible at ``http://localhost:8080``, with the code coverage 
-report for your build at ``http://localhost:8081`` and the user guide for 
+Your webapp will be accessible at ``http://localhost:8080``, with the code coverage
+report for your build at ``http://localhost:8081`` and the user guide for
 it at ``http://localhost:8082``.