DevConf 2015

Servidor web embutido

Aviso

Esse servidor web foi desenvolvido para auxiliar no desenvolvimento de aplicações. Ele também pode ser útil para testes ou para demonstrações de aplicações que forem executadas em ambientes contralados. Ele não foi desenvolvido para ser um web server completo. Ele não deve ser utilizado em uma rede pública.

A partir do PHP 5.4.0, o CLI SAPI fornece um servidor web embutido.

Apllições PHP irão parar se a requisição for bloqueada.

Requisições de URI são servidas a partir do diretório atual onde o PHP foi iniciado, a não ser que a opção -t seja usada para especificar uma raiz de documento explicitamente. Se uma requisição de URI não contiver um arquivo específico então ou o index.php ou index.html no diretório em questão será retornado. Se nenhum deles existir então um erro de código 404 será retornado.

Se um arquivo PHP for fornecido na linha de comando quando o servidor web for iniciado ele será tratado como roteador. O script é executado no inicio de cada requisição HTTP. Se o script retornar FALSE, então o recurso requisitado será retornado da maneira como estiver. Do contrário a saída do script será retornada para o navegador.

MIME types padrões serão retornados para arquivos com as extensões: .3gp, .apk, .avi, .bmp, .css, .csv, .doc, .docx, .flac, .gif, .gz, .gzip, .htm, .html, .ics, .jpe, .jpeg, .jpg, .js, .kml, .kmz, .m4a, .mov, .mp3, .mp4, .mpeg, .mpg, .odp, .ods, .odt, .oga, .ogg, .ogv, .pdf, .pdf, .png, .pps, .pptx, .qt, .svg, .swf, .tar, .text, .tif, .txt, .wav, .webm, .wmv, .xls, .xlsx, .xml, .xsl, .xsd, and .zip.

Documento de mudanças: MIME Types suportados (extensões de arquivos)
Versão Descrição
5.5.12 .xml, .xsl, and .xsd
5.5.7 .3gp, .apk, .avi, .bmp, .csv, .doc, .docx, .flac, .gz, .gzip, .ics, .kml, .kmz, .m4a, .mp3, .mp4, .mpg, .mpeg, .mov, .odp, .ods, .odt, .oga, .pdf, .pptx, .pps, .qt, .swf, .tar, .text, .tif, .wav, .wmv, .xls, .xlsx, and .zip
5.5.5 .pdf
5.4.11 .ogg, .ogv, and .webm
5.4.4 .htm and .svg

Exemplo #1 Iniciando o servidor web

$ cd ~/public_html
$ php -S localhost:8000

O terminal irá exibir:

PHP 5.4.0 Development Server started at Thu Jul 21 10:43:28 2011
Listening on localhost:8000
Document root is /home/me/public_html
Press Ctrl-C to quit

Após serem feitas requisições de URI para for http://localhost:8000/ e http://localhost:8000/myscript.html o terminal irá exibir algo similiar a:

PHP 5.4.0 Development Server started at Thu Jul 21 10:43:28 2011
Listening on localhost:8000
Document root is /home/me/public_html
Press Ctrl-C to quit.
[Thu Jul 21 10:48:48 2011] ::1:39144 GET /favicon.ico - Request read
[Thu Jul 21 10:48:50 2011] ::1:39146 GET / - Request read
[Thu Jul 21 10:48:50 2011] ::1:39147 GET /favicon.ico - Request read
[Thu Jul 21 10:48:52 2011] ::1:39148 GET /myscript.html - Request read
[Thu Jul 21 10:48:52 2011] ::1:39149 GET /favicon.ico - Request read

Exemplo #2 Iniciando o servidor web com um diretório raiz específico

$ cd ~/public_html
$ php -S localhost:8000 -t foo/

O terminal irá exibir:

PHP 5.4.0 Development Server started at Thu Jul 21 10:50:26 2011
Listening on localhost:8000
Document root is /home/me/public_html/foo
Press Ctrl-C to quit

Exemplo #3 Usando um script de roteamento

Nesse exemplo, requisições para imagens serão exibidas, mas requisições para arquivos HTML irão exibir "Welcome to PHP":

<?php
// router.php
if (preg_match('/\.(?:png|jpg|jpeg|gif)$/'$_SERVER["REQUEST_URI"])) {
    return 
false;    // serve the requested resource as-is.
} else { 
    echo 
"<p>Welcome to PHP</p>";
}
?>
$ php -S localhost:8000 router.php

Exemplo #4 Verificando o Uso do CLI Web Server

Para reutilizar um script de roteamente específico de um framework durante o desenvolvimento com o servidor web CLI e depois também em um servidor de produção:

<?php
// router.php
if (php_sapi_name() == 'cli-server') {
    
/* route static assets and return false */
}
/* go on with normal index.php operations */
?>
$ php -S localhost:8000 router.php

Exemplo #5 Tratando de tipos de arquivos não suportados

Se você precisar servir um recurso estático cujo MIME type não é tratado pelo servidor web CLI, use:

<?php
// router.php
$path pathinfo($_SERVER["SCRIPT_FILENAME"]);
if (
$path["extension"] == "el") {
    
header("Content-Type: text/x-script.elisp");
    
readfile($_SERVER["SCRIPT_FILENAME"]);
}
else {
    return 
FALSE;
}
?>
$ php -S localhost:8000 router.php

Exemplo #6 Accessando o servidor web CLI de máquinas remotas

Você pode tornar o servidor web acessível na porta 8000 para qualquer interface com:

$ php -S 0.0.0.0:8000
add a note add a note

User Contributed Notes 10 notes

up
35
jonathan at reinink dot ca
1 year ago
In order to set project specific configuration options, simply add a php.ini file to your project, and then run the built-in server with this flag:

php -S localhost:8000 -c php.ini

This is especially helpful for settings that cannot be set at runtime (ini_set()).
up
21
Ivan Ferrer
1 year ago
On Windows you may find useful to have a phpserver.bat file in shell:sendto with the folowing:
explorer http://localhost:8888
rem check if arg is file or dir
if exist "%~1\" (
  php -S localhost:8888 -t "%~1"
) else (
  php -S localhost:8888 -t "%~dp1"
)

then for fast web testing you only have to SendTo a file or folder to this bat and it will open your explorer and run the server.
up
6
tamas at bartatamas dot hu
7 months ago
If your URI contains a dot, you'll lose the $_SERVER['PATH_INFO'] variable, when using the built-in webserver.
I wanted to write an API, and use .json ending in the URI-s, but then the framework's routing mechanism broke, and it took a lot of time to discover that the reason behind it was its router relying on $_SERVER['PATH_INFO'].

References:
https://bugs.php.net/bug.php?id=61286
up
2
simonbengt at gmail dot com
2 months ago
My routing file looks like this:

if (file_exists($_SERVER["DOCUMENT_ROOT"] . $_SERVER["REQUEST_URI"])) {
    return false;
} else {
    require "index.php";
}

The reason is to support all static files.
up
16
dstrout at dstrout dot net
2 years ago
Just gave it a try, and it is IPv6 compatible, if anyone was wondering.
up
2
Tan
7 months ago
Is there anyway to unassign the port used?
up
2
sixd at php dot net
1 year ago
The .xml, .xsl, and .xsd extensions were added to PHP 5.5.12 (and what will be PHP 5.6) (bug #67079 )
up
-9
shenzhuxi at gmail dot com
1 year ago
How to avoid this error.

This page contains the following errors:
error on line XX at column X: Extra content at the end of the document
Below is a rendering of the page up to the first error.

<?php
$path
= pathinfo($_SERVER["SCRIPT_FILENAME"]);
if (
$path['extension']=='xhtml') {
 
header('Content-Type: application/xhtml+xml;charset=utf-8');
 
readfile($_SERVER["SCRIPT_FILENAME"]);
  exit;
//Without it, the file will be output twice.
}
?>
up
-19
tobi at saibotd dot com
1 year ago
A more complete example of a router file:

<?php
// router.php

$route = parse_url(substr($_SERVER["REQUEST_URI"], 1))["path"];

if (
is_file($route)) {
    if(
substr($route, -4) == ".php"){
        require
$route;         // Include requested script files
       
exit;
    }
    return
false;               // Serve file as is
} else {                        // Fallback to index.php
   
$_GET["q"] = $route;        // Try to emulate the behaviour of your htaccess here, if needed
   
require "index.php";
}

This should give you a basic development enviroment.
up
-24
Stefano F. Rausch
3 years ago
To develop / deploy websites in 3 stages, i.e. ( 1 ) locally, ( 2 ) with an access controlled dedicated beta / test website in the www and ( 3 ) the production site, you can have ( 1 ) & ( 2 ) using the same domain name - port free - as follows:

- look up the IP address of the beta.web.site

and edit the hosts file to reflect:

- <IP> beta.web.site
- 127.0.0.1 beta.web.site

Start the built-in web server to work locally with:

- sudo php -S beta.web.site:80

and just hit http://beta.web.site as usual. Switching back and forth between ( 1 ) and ( 2 ) is as easy as telling the php engine not to fake a server any more :) Nice!

Happy PHP'ing.
To Top