Documentation Packages Getting Started FAQ Support

Aerys ⋅ Introduction

Aerys is a non-blocking HTTP/1.1 and HTTP/2 application, WebSocket and static file server written in PHP.

Installation

composer require amphp/aerys

First Run

vendor/bin/aerys -d -c demo.php

On production you’ll want to drop the -d (debug mode) flag. For development it is pretty helpful though. -c demo.php tells the program where to find the config file.

First Configuration

<?php

return (new Aerys\Host)->use(Aerys\root("/var/www/public_html"));

Save it as config.php and load it via sudo php vendor/bin/aerys -d -c config.php. The sudo may be necessary as it binds by default on port 80 - for this case there is an user option to drop the privileges.

That’s all needed to serve files from a static root. Put an index.html there and try opening http://localhost/ in the browser.

The host instance is at the root of each virtual host served by Aerys. By default it serves your content over port 80 on localhost. To configure an alternative binding, have a look here.

The root($path) function returns a handler for static file serving and expects a document root path to serve files from as first parameter.

Debug mode is most helpful when zend.assertions is set to 1. If it isn’t set to 1 in your config, load the server with php -d zend.assertions=1 vendor/bin/aerys -d -c config.php.