Fine tuning on the PHP Built-in web server.

v2.11 2019-11-13 13:26 UTC

This package is auto-updated.

Last update: 2024-05-17 04:22:51 UTC


Latest release PHP version Packagist downloads

Fine tuning on the PHP Built-in web server

PHP Built-in web server autoindex

See release notes at:



Open your terminal and run:

composer global require natanfelles/php-server

Add the composer bin path to your .bashrc:

echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc


Download and extract the php-server project folder.

Add the php-server alias to your .bashrc:

echo 'alias php-server="~/php-server/bin/php-server"' >> ~/.bashrc


You can run the php-server in any folder of your operating system.

Each time you run the php-server command, it will look up if there is a file named php-server.ini in the current directory. If found, your settings will override the default settings.

A quick example file content is:

host = localhost
port = 8080
root = ./public
autoindex = true
index = index.php
error_reporting = E_ALL

display_errors = 1
display_startup_errors = 1
max_execution_time = 360
post_max_size = 200M
upload_max_filesize = 200M
; Array of runtime extensions:
extension[] = mysqli
extension[] = zip

ENVIRONMENT = development

You can use the command php-server new to create a new configuration file in the current directory.


General Vars

Key Default Value Description
php PHP_BINARY PHP binary path or command
host localhost Server host
port 8080 Server host port
root getcwd() Document root. The location that will be the public root of your website.
autoindex true Determines if the server will list directory contents if it does not find an index file.
index index.html index.php The names of the index files separated by spaces.
error_reporting E_ALL Sets the level of errors that will be reported.


Section Description
ini Used to set custom php.ini directives.
server Used to set custom Server and execution environment information.

Knowing this, just create (if necessary) a php-server.ini file, run the server and you're done.


As you can see in the config. You can create a php-server.ini file to leave the settings of each project already pre-established.

But, you can also simply run php-server and the server will already be available at http://localhost:8080.

The php-server command can receive some parameters and they are:

Parameter Description
--php PHP binary path or command
--host Server host
--port Server host port
--root Document root

For example, to run the server on a different port:

php-server --port 8081

Or, also with a different version of PHP than the default:

php-server --php php7.4 --port 8081

Right. You get the idea. If you want to run on a different host you can add the host to the hosts file of your operating system.


Hello, how nice that you are reading this.

If you have any idea to improve this project or something is not working as it should, do not hesitate to open an issue and if you have solved the problem feel free to open a Pull Request.