docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 11 commits into from
Jul 11, 2023
Merged

docs: improve "Hosting with Apache" #7679

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b352160
docs: fix Section Headings marks
kenjis Jul 8, 2023
35e5342
docs: indent config values in sample
kenjis Jul 8, 2023
92e5a8f
docs: add sub section titles and fix
kenjis Jul 8, 2023
0a1e43a
docs: add new line
kenjis Jul 8, 2023
c917982
docs: change sub section order
kenjis Jul 8, 2023
fdf3252
docs: change sub section titles and level
kenjis Jul 8, 2023
18d5cf4
docs: change TOC depth to 3
kenjis Jul 8, 2023
eb465d9
docs: add ".. code-block:: apache"
kenjis Jul 8, 2023
9afea6f
docs: add new line
kenjis Jul 8, 2023
d98ec38
docs: change location of project folder and explanin folder structure
kenjis Jul 8, 2023
45165e1
docs: fix directory separator for Windows
kenjis Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 127 additions & 79 deletions user_guide_src/source/installation/running.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
:local:
:depth: 2
:depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
your project, so that it is writable by the user or account used by your
web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

> php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

> php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

<Directory "/opt/lamp/apache2/htdocs">
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
</Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

<VirtualHost *:80>
DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
ServerName myproject.local
ErrorLog "logs/myproject-error_log"
CustomLog "logs/myproject-access_log" common
DocumentRoot "/opt/lamp/apache2/myproject/public"
ServerName myproject.local
ErrorLog "logs/myproject-error_log"
CustomLog "logs/myproject-access_log" common

<Directory "/opt/lamp/apache2/myproject/public">
AllowOverride All
Require all granted

@MGatnerMGatnerJul 11, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?

@kenjiskenjisJul 11, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:

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 server access to the files.

/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.
It is not good. So I moved it.

</Directory>
</VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
apache2/
├── myproject/ (Project Folder)
│ └── public/ (DocumentRoot for myproject.local)
└── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

<IfModule mod_userdir.c>
UserDir "public_html/public" "public_html"
UserDir disabled root

<Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
Comment on lines +229 to +230

@MGatnerMGatnerJul 11, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.

@kenjiskenjisJul 11, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.

</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
</Directory>

<Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
</Directory>
</IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
}

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs: improve "Hosting with Apache"#7679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 11 commits into

from

Jul 11, 2023
 Merged


docs: improve "Hosting with Apache"
#7679
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
b352160

docs: fix Section Headings marks


kenjis Jul 8, 2023
35e5342

docs: indent config values in sample


kenjis Jul 8, 2023
92e5a8f

docs: add sub section titles and fix


kenjis Jul 8, 2023
0a1e43a

docs: add new line


kenjis Jul 8, 2023
c917982

docs: change sub section order


kenjis Jul 8, 2023
fdf3252

docs: change sub section titles and level


kenjis Jul 8, 2023
18d5cf4

docs: change TOC depth to 3


kenjis Jul 8, 2023
eb465d9

docs: add ".. code-block:: apache"


kenjis Jul 8, 2023
9afea6f

docs: add new line


kenjis Jul 8, 2023
d98ec38

docs: change location of project folder and explanin folder structure


kenjis Jul 8, 2023
45165e1

docs: fix directory separator for Windows


kenjis Jul 11, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


206 changes: 127 additions & 79 deletions
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
################
Running Your App
################

.. contents::
 :local:
 :depth: 2
 :depth: 3

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.
Expand All@@ -20,8 +21,9 @@ section of the User Guide to begin learning how to build dynamic PHP application

.. _initial-configuration:

*********************
Initial Configuration
=====================
*********************

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
Expand DownExpand Up@@ -49,11 +51,12 @@ Initial Configuration
 your project, so that it is writable by the user or account used by your
 web server.

************************
Local Development Server
========================
************************

CodeIgniter 4 comes with a local development server, leveraging PHP's built-in web server
with CodeIgniter routing. You can launch it, with the following command line
with CodeIgniter routing. You can launch it, with the following command line
in the main directory::

 > php spark serve
Expand DownExpand Up@@ -83,156 +86,200 @@ The local development server can be customized with three command line options:

 > php spark serve --php /usr/bin/php7.6.5.4

*******************
Hosting with Apache
===================
*******************

A CodeIgniter4 webapp is normally hosted on a web server.
Apache HTTP Server 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>`_.

.htaccess
---------
Configure Main Config File
==========================

Enabling mod_rewrite
--------------------

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
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule rewrite_module modules/mod_rewrite.so

Setting Document Root
---------------------

Also make sure that the default document root's ``<Directory>`` element enables this too,
in the ``AllowOverride`` setting::
in the ``AllowOverride`` setting:

.. code-block:: apache

 <Directory "/opt/lamp/apache2/htdocs">
 Options Indexes FollowSymLinks
 AllowOverride All
 Require all granted
 </Directory>

Removing the index.php
----------------------

See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

Virtual Hosting
---------------
Hosting with VirtualHost
========================

We recommend using "virtual hosting" to run your apps.
You can set up different aliases for each of the apps you work on,

Enabling vhost_alias_module
---------------------------

Make sure that the virtual hosting module is enabled (uncommented) in the main
configuration file, e.g., **apache2/conf/httpd.conf**::
configuration file, e.g., **apache2/conf/httpd.conf**:

.. code-block:: apache

 LoadModule vhost_alias_module modules/mod_vhost_alias.so

Adding Host Alias
-----------------

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::
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

Setting VirtualHost
-------------------

Add a ``<VirtualHost>`` element for your webapp inside the virtual hosting configuration,
e.g., **apache2/conf/extra/httpd-vhost.conf**::
e.g., **apache2/conf/extra/httpd-vhost.conf**:

.. code-block:: apache

 <VirtualHost *:80>
 DocumentRoot "/opt/lamp/apache2/htdocs/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common
 DocumentRoot "/opt/lamp/apache2/myproject/public"
 ServerName myproject.local
 ErrorLog "logs/myproject-error_log"
 CustomLog "logs/myproject-access_log" common

 <Directory "/opt/lamp/apache2/myproject/public">
 AllowOverride All
 Require all granted
@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I've used this directive before. Is it necessary? Secure? Advised?
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it was documented:
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 server access to the files.
/opt/lamp/apache2/htdocs/myproject/public is in the main document root /opt/lamp/apache2/htdocs.

It is not good. So I moved it.
 </Directory>
 </VirtualHost>

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 server access to the files.
The above configuration assumes the project folder is located as follows:

.. code-block:: text

With mod_userdir (Shared Hosts)
--------------------------------
 apache2/
 ├── myproject/ (Project Folder)
 │ └── public/ (DocumentRoot for myproject.local)
 └── htdocs/

Testing
-------

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.

Apache needs to be restarted whenever you change its configuration.

Hosting with mod_userdir (Shared Hosts)
=======================================

A common practice in shared hosting environments is to use the Apache module "mod_userdir" to enable per-user Virtual Hosts automatically. Additional configuration is required to allow CodeIgniter4 to be run from these per-user directories.

The following assumes that the server is already configured for mod_userdir. A guide to enabling this module is available `in the Apache documentation <https://httpd.apache.org/docs/2.4/howto/public_html.html>`_.

Because CodeIgniter4 expects the server to find the framework front controller at **public/index.php** by default, you must specify this location as an alternative to search for the request (even if CodeIgniter4 is installed within the per-user web directory).

The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**::
The default user web directory **~/public_html** is specified by the ``UserDir`` directive, typically in **apache2/mods-available/userdir.conf** or **apache2/conf/extra/httpd-userdir.conf**:

.. code-block:: apache

 UserDir public_html

So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default::
So you will need to configure Apache to look for CodeIgniter's public directory first before trying to serve the default:

.. code-block:: apache

 UserDir "public_html/public" "public_html"

Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like::
Be sure to specify options and permissions for the CodeIgniter public directory as well. A **userdir.conf** might look like:

.. code-block:: apache

 <IfModule mod_userdir.c>
 UserDir "public_html/public" "public_html"
 UserDir disabled root

 <Directory /home/*/public_html>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted

Comment on lines

+229
 to 
+230

@MGatnerMGatnerJul 11, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, it looks like this is a new approach. I trust you on this.
@kenjiskenjisJul 11, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you mean? The change here is simply a change in indentation.
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>

 <Directory /home/*/public_html/public>
AllowOverride All
Options MultiViews Indexes FollowSymLinks
<Limit GET POST OPTIONS>
# Apache <= 2.2:
# Order allow,deny
# Allow from all

# Apache >= 2.4:
Require all granted
</Limit>
<LimitExcept GET POST OPTIONS>
# Apache <= 2.2:
# Order deny,allow
# Deny from all

# Apache >= 2.4:
Require all denied
</LimitExcept>
 AllowOverride All
 Options MultiViews Indexes FollowSymLinks
 <Limit GET POST OPTIONS>
 # Apache <= 2.2:
 # Order allow,deny
 # Allow from all

 # Apache >= 2.4:
 Require all granted
 </Limit>
 <LimitExcept GET POST OPTIONS>
 # Apache <= 2.2:
 # Order deny,allow
 # Deny from all

 # Apache >= 2.4:
 Require all denied
 </LimitExcept>
 </Directory>
 </IfModule>

Setting Environment
-------------------

See :ref:`Handling Multiple Environments <environment-apache>`.
Removing the index.php
======================

Testing
-------
See :ref:`CodeIgniter URLs <urls-remove-index-php-apache>`.

With the above configuration, your webapp would be accessed with the URL **http://myproject.local/** in your browser.
Setting Environment
===================

Apache needs to be restarted whenever you change its configuration.
See :ref:`Handling Multiple Environments <environment-apache>`.

******************
Hosting with Nginx
==================
******************

Nginx is the second most widely used HTTP server for web hosting.
Here you can find an example configuration using PHP 8.1 FPM (unix sockets) under Ubuntu Server.

default.conf
------------
============

This configuration enables URLs without "index.php" in them and using CodeIgniter's "404 - File Not Found" for URLs ending with ".php".

Expand DownExpand Up@@ -269,12 +316,13 @@ This configuration enables URLs without "index.php" in them and using CodeIgnite
 }

Setting Environment
-------------------
===================

See :ref:`Handling Multiple Environments <environment-nginx>`.

*********************
Bootstrapping the App
=====================
*********************

In some scenarios you will want to load the framework without actually running the whole
application. This is particularly useful for unit testing your project, but may also be
Expand Down